JSON SchemaからTypeScriptへ
JSON SchemaをTypeScriptの型に変換します。オブジェクトは必須プロパティと省略可能なプロパティを持つインターフェースになり、$defsと定義は$refが参照する名前付きエクスポートになります。enumとconstはリテラル型、anyOfとoneOfはユニオン型、allOfは交差型になります。説明はドキュメントコメントとして保持されます。
よくある質問
どのJSONスキーマドラフトに対応していますか?
このコンバーターは、draft-07、2019-09、2020-12で共通するキーワードを読み取ります。type、properties、required、additionalProperties、items、prefixItems、enum、const、anyOf、oneOf、allOf、$ref、$defsまたはdefinitionsが対象です。minLengthやpatternなどの検証キーワードにはTypeScriptに相当するものがないため、省略されます。
$ref参照はどのように解決されますか?
#、#/$defs/Name、#/definitions/Nameへの参照は、その定義の名前付き型になります。別ファイルやURLなど、ほかの参照はunknown型になり、出力の先頭にコメントとして記載されます。
additionalPropertiesはどのように処理されますか?
プロパティがなくadditionalPropertiesのスキーマがあるオブジェクトはRecord<string, T>になります。プロパティとadditionalPropertiesのスキーマがあるオブジェクトは、インターフェースとRecord<string, T>を結合した型になります。additionalPropertiesがfalseの場合やキーワードがない場合は何も追加されません。TypeScriptのオブジェクト型で既知のキーをすでに記述できるためです。
nullableはどのような動作をしますか?
OpenAPI 3.0のnullable: trueキーワードとSwaggerのx-nullable拡張は、型に| nullを追加します。JSON Schema自体では、type: ["string", "null"]と記述するとstring | nullになります。
再帰スキーマはサポートされていますか?
はい。定義が$refを介して自身や別の定義を参照する場合、別の名前を参照する名前付き型になります。TypeScriptは問題なく解決できます。
スキーマが有効かどうかも検証しますか?
スキーマを読み取るだけです。不明なキーワードは無視され、typeのないスキーマはunknownになります。データがスキーマに適合するか確認するには、JSON Schema Validatorを使ってください。