JSON SchemaからZodへ
JSON SchemaをZodスキーマに変換します。型、必須プロパティ、enum、const、anyOf、oneOf、allOfはZodのビルダーに対応し、minLength、maximum、pattern、format、minItemsなど一般的な検証キーワードはZodのチェックになります。各定義はz.infer型付きのエクスポート済みスキーマになります。
よくある質問
どの検証キーワードが変換されますか?
minLengthとmaxLengthは文字列の.min()と.max()に、patternは.regex()になります。email、uri、uuid、date-timeの各形式は、それぞれ.email()、.url()、.uuid()、.datetime()になります。minimum、maximum、exclusiveMinimum、exclusiveMaximum、multipleOfは数値チェックに、minItemsとmaxItemsは配列チェックになります。
定義はどのような順序で並びますか?
すべての定義は、それを使用するスキーマより前に宣言されます。定義が直接または別の定義を介して自身を参照する場合、コードが実行できるようにz.lazyで参照されます。
再帰スキーマは型チェックできますか?
実行はできますが、TypeScriptはz.lazyを介して自身を参照するスキーマの型を推論できません。そのようなスキーマには、再帰型について説明しているZodのドキュメントに従って、明示的な型注釈を追加してください。
additionalPropertiesはどのように処理されますか?
additionalPropertiesがfalseの場合は.strict()が追加され、スキーマがある場合はそのスキーマを指定した.catchall()が追加されます。trueの場合は.passthrough()が追加され、プロパティがなくadditionalPropertiesスキーマがあるオブジェクトはz.record(z.string(), ...)になります。
このコードが対象とするZodのバージョンは?
z.object、z.union、キーのスキーマを指定したz.record、.nullable()など、生成されるビルダーはZod 3とZod 4の両方にあります。Zod 4でも.email()などの文字列形式メソッドを使用できます。また、より短い書き方としてz.email()も用意されています。
ツールで解決できない参照はどうなりますか?
別ファイルやURLなど、ドキュメント外への参照はz.unknown()になり、出力の先頭にコメントとして記載されます。