JSON Schema 转 Zod
将 JSON Schema 转换为 Zod Schema。类型、必填属性、枚举、const、anyOf、oneOf 和 allOf 会映射到对应的 Zod 构造器;minLength、maximum、pattern、format 和 minItems 等常见验证关键字会变为 Zod 检查。每个定义都会变为导出的 Schema,并带有 z.infer 类型。
常见问题
哪些验证关键字会被转换?
minLength 和 maxLength 会分别变为字符串上的 .min() 和 .max(),pattern 会变为 .regex(),email、uri、uuid 和 date-time 格式会分别变为 .email()、.url()、.uuid() 和 .datetime()。minimum、maximum、exclusiveMinimum、exclusiveMaximum 和 multipleOf 会变为数字检查;minItems 和 maxItems 会变为数组检查。
定义按什么顺序排列?
每个定义都会在使用它的 Schema 之前声明。直接或间接引用自身的定义会使用 z.lazy 引用,以确保代码仍能运行。
递归 Schema 能通过类型检查吗?
它们可以运行,但 TypeScript 无法推断通过 z.lazy 自身引用的 Schema 类型。请为此类 Schema 添加显式类型注解,Zod 文档中介绍了递归类型的相关做法。
如何处理 additionalProperties?
additionalProperties 为 false 时会添加 .strict();提供 Schema 时会添加带该 Schema 的 .catchall();值为 true 时会添加 .passthrough();没有属性但带有 additionalProperties Schema 的对象会变为 z.record(z.string(), ...)。
代码面向哪个 Zod 版本?
生成的构造器,例如 z.object、z.union、带有键 Schema 的 z.record 和 .nullable(),在 Zod 3 和 Zod 4 中均可使用。Zod 4 仍接受 .email() 等字符串格式方法,同时也提供更简短的 z.email() 写法。
工具无法解析的引用会怎样处理?
指向文档外部的引用,例如另一个文件或 URL,会变为 z.unknown(),并列在输出顶部的注释中。