JSONからZodへ
JSONのサンプルからZodスキーマを生成します。ネストされたオブジェクトはそれぞれ独立したエクスポート可能なスキーマになり、一部の配列要素に存在しないキーには.optional()、null値には.nullable()、型が混在する値にはz.unionを使用します。各スキーマにはz.infer型エイリアスも追加されるため、1回の貼り付けで実行時検証とTypeScript型を利用できます。
よくある質問
ネストされたオブジェクトにはどのような名前が付けられますか?
ネストされたオブジェクトはそれぞれ独立したZod型になり、それを含むキーをもとにPascalCaseで命名されます。たとえばaddressはAddressになります。配列内のオブジェクトには、配列キーの単数形が使われるため、usersはUserになります。フィールドが完全に同じオブジェクトは、同じ型を共有します。
フィールドがオプションになるのはどのような場合ですか?
配列に複数のオブジェクトがあり、一部のオブジェクトにキーがない場合、そのフィールドはオプションになります。スキーマには.optional()が追加されます。すべてのサンプルに存在するキーは必須です。単一のオブジェクトでは比較対象がないため、すべてのキーが必須になります。
null値はどのように扱われますか?
一部のサンプルではnullで、ほかのサンプルでは値が入っているキーは、型の後ろに.nullable()が付加されます。常にnullのキーからは実際の型を判断できないため、z.null()になります。正確な型を得るには、実際の値を含むサンプルを貼り付けてください。
どの数値型が使われますか?
整数はz.number().int()になり、小数を含む数値はz.number()になります。同じフィールドに両方が入る場合、すべての整数が有効な数値でもあるため、スキーマにはz.number()が使われます。
有効な名前ではないキーはどうなりますか?
first-nameのような有効なJavaScript識別子ではないキーは、z.object内で引用符で囲まれます。そのため、スキーマは元のJSONキーと完全に一致します。
JSONはアップロードまたは保存されますか?
JSONはこのリクエストのコード生成にのみ使用するためサーバーに送信され、保存されません。ジェネレーターが読み取るのはサンプルの構造と値の型だけなので、貼り付ける前に、機密性の高い値を同じ型のプレースホルダーに置き換えることができます。