JSON转Typescript Zod类

工具简介

本工具旨在帮助开发者快速将任意JSON数据结构转换为对应的TypeScript Zod Schema代码。Zod是一个流行的TypeScript优先的声明式验证库，它允许你用简洁的语法定义数据的形状和类型，并在运行时进行验证，同时提供强大的TypeScript类型推断能力。通过本工具，你可以轻松地将API返回的数据、配置文件、或者任何结构化的JSON数据快速生成可用于校验的Zod模式，极大地提高了开发效率和代码的类型安全性。

Zod Schema的优势

• 类型安全： 在运行时强制执行类型检查，避免因数据格式不匹配导致的错误。
• 优秀的TypeScript集成： Zod Schema能自动推断出TypeScript类型，减少手动编写类型定义的工作量。
• 简洁的API： 提供直观易懂的API，让Schema定义清晰明了。
• 可组合性： 支持Schema的组合与重用，方便构建复杂的数据结构。
• 错误处理： 提供详细且友好的验证错误信息，便于调试和用户提示。

如何使用

1. 在输入框中粘贴您需要转换的JSON数据字符串。
2. （可选）根据需求配置生成选项，例如是否为顶级Schema命名，或者是否包含z.infer类型定义。
3. 点击“转换”按钮，工具将即时分析JSON结构并生成对应的Zod Schema代码。
4. 复制生成的TypeScript Zod代码，并将其集成到您的项目中。

输入参数的格式和要求： 请确保输入的是格式良好、有效的JSON字符串。工具将自动解析并尝试推断出最合适的Zod类型（如字符串、数字、布尔值、对象、数组等）。

输出结果的格式： 输出结果是标准的TypeScript代码，包含import { z } from 'zod';语句以及一个或多个Zod Schema定义。

使用示例

以下是一个将JSON数据转换为Zod Schema的实际案例：

• 示例输入数据：

  {
    "userId": 123,
    "userName": "John Doe",
    "email": "john.doe@example.com",
    "isActive": true,
    "roles": ["admin", "editor"],
    "profile": {
      "age": 30,
      "city": "New York"
    },
    "lastLogin": null
  }

• 预期输出结果：

  import { z } from 'zod';
  
  const UserProfileSchema = z.object({
    age: z.number(),
    city: z.string(),
  });
  
  const UserSchema = z.object({
    userId: z.number(),
    userName: z.string(),
    email: z.string().email(), // 邮箱类型会根据格式自动推断或需要手动完善
    isActive: z.boolean(),
    roles: z.array(z.string()),
    profile: UserProfileSchema,
    lastLogin: z.null().or(z.string().datetime()), // null或日期字符串，可能需要手动调整
  });
  
  // 可选：生成TypeScript类型
  // type User = z.infer;
  

• 具体的操作演示： 只需将上述JSON数据粘贴到工具的输入区域，然后点击“转换”按钮，您就可以在输出区域看到相应的Zod Schema代码。

常见问题

• 问：此工具支持哪些JSON数据类型到Zod类型的转换？ 答：本工具支持所有标准JSON数据类型，包括字符串 (z.string())、数字 (z.number())、布尔值 (z.boolean())、对象 (z.object())、数组 (z.array()) 和 null (z.null())。对于特定格式的字符串（如邮箱、URL、日期时间），工具会尝试推断或建议手动优化为z.string().email(), z.string().url(), z.string().datetime()等。
• 问：生成的Zod Schema可以用于哪些场景？ 答：生成的Zod Schema广泛用于前端表单数据校验、API请求参数与响应数据校验、配置文件格式验证、数据库模型定义以及任何需要数据结构验证的TypeScript项目。
• 问：如果JSON中包含可选字段，Zod如何处理？ 答：默认情况下，工具会认为JSON中出现的字段都是必需的。如果您的字段是可选的，您需要在生成后手动在对应的Zod Schema字段上添加.optional()修饰符，例如：fieldName: z.string().optional()。
• 问：如何处理JSON中的枚举类型？ 答：工具目前不会自动识别字符串或数字的枚举类型。对于枚举，您需要在生成后手动修改为z.enum(['value1', 'value2'])或z.union([z.literal(1), z.literal(2)])等形式。

注意事项

• 输入数据的格式要求： 请务必确保您输入的JSON字符串是合法且格式正确的。任何JSON语法错误都可能导致转换失败。
• 复杂类型的手动优化： 尽管工具会尽力推断类型，但对于复杂的类型（如日期字符串、邮箱、URL等），可能需要您在生成代码后手动添加更精确的Zod校验器（如.datetime()、.email()、.url()等）以确保最高的准确性。
• 隐私与安全： 在使用任何在线工具时，请避免输入包含敏感或个人身份信息的JSON数据，以保护您的隐私安全。
• 字段的可选性： 工具默认将所有JSON字段视为必需。如果您的某些字段是可选的，请在生成的Zod Schema中手动添加.optional()修饰符。