zod-graphql-type 中文文档教程

Question

zod-graphql-type

ZodError GraphQL 类型，以便您可以返回 zod GraphQL API 中的错误。

作为示例用例，我们假设您有一个 GraphQL 突变，可以将用户登录到您的应用程序中。该突变接受 Google oAuth 令牌来对用户进行身份验证。 GraphQL 可以确保突变上的输入类型是正确的。但是，在 GraphQL 解析器中，您需要验证 oAuth 令牌的完整性。验证令牌的完整性后，您可以使用 zod 模式验证令牌对象。该包允许您将 zod 抛出的任何错误返回给您的 API 使用者，以获得清晰的错误详细信息。

这个包为您提供了 3 个东西：

1. ZodError 类型定义，可导入到您的 GraphQL 架构中以用于其他类型；
2. 自定义 GraphQL 解析器以使 ZodError 类型定义起作用；
3. formatErrors zodErrorsTozodIssues 函数，用于将 ZodError（其中有 Error 对象，因此不能很好地与 GraphQL 配合使用）转换为 ZodIssues（没有 Error 对象） ）。

入门

安装

npm install zod-zod-graphql-type

用法

import { zodTypeDef } from "zod-graphql-type";

然后将类型定义添加到您的 GraphQL 类型架构中。

以下是 Fastify Mercurius 示例：

import { Fastify } from "fastify";
import mercurius from "mercurius";
import { z } from "zod";
import { zodTypeDef, scalars, zodErrorsTozodIssues } from "zod-graphql-type";

const fastify = Fastify();

const schema = `
  ${zodTypeDef},
  input ObjectToValidate {
    phraseFirstHalf: String
  }
  type Success {
    message: String!
  }
  type Error {
    message: String!
    zodIssues: [ZodIssue]
  }
  type Query {
    validatePhrase(input: ObjectToValidate): Success | Error
  }
`;

const resolvers = {
  Query: {
    validatePhrase: (_, { phrase }) => {
      const phraseSecondHalf = fetch(`https://someapi.com?phrase=${phrase}`);
      // Create a zod schema to validate the argument
      const schema = z.object({
        phrase: z.literal("world"),
      });
      try {
        schema.parse(phraseSecondHalf);
        return {
          __typename: "Success",
          message: "Object passed validation.",
        };
      } catch (error) {
        return {
          __typename: "Error",
          message: "Object failed vlaidation.",
          zodIssues: zodErrorsTozodIssues(error),
        };
      }
    },
  },
};

app.register(mercurius, {
  schema,
  resolvers,
});

app.get("/", async function (req, reply) {
  const query = '{ validatePhrase(input: {phraseFirstHalf: "world"})}';
  return reply.graphql(query);
});

app.listen({ port: 3000 });

请注意，您需要使用 formatErrors 函数，该函数将 ZodError 替换为 ZodIssue[]。 ZodError 的类型为 Error，如果您向 GraphQL 返回 Error 类型，它将不允许您正确返回 ZodIssues。

特性

绝大多数 ZodError 类型都经过测试并且可以工作。以下内容经过测试：

• ZodIssueCode.invalid_type
• ZodIssueCode.unrecognized_keys
• ZodIssueCode.invalid_union
• ZodIssueCode.invalid_enum_value
• ZodIssueCode。 Too_big
• ZodIssueCode.too_small
• ZodIssueCode.invalid_type =>自定义错误
• ZodIssueCode.invalid_string
• ZodIssueCode.invalid_date
• ZodIssueCode.not_multiple_of

已知以下内容尚无法工作（可以在未来）：

• ZodIssueCode.invalid_arguments 由 z.function().args().implement() 产生的错误
• ZodIssueCode.invalid_return_type 一个错误由 z.function().returnType().implement() 生成

除了使用 .implement()z.function() 函数架构之外的所有内容代码>应该可以正常工作。如果您发现错误，请创建问题。

注释

这还不是 1.0.0 版本。由于该功能正在积极开发中，因此版本控制在 1.0.0 之前不会遵循 SEMVER。