JSONスキーマジェネレーター
サンプルJSONからJSONスキーマを生成します。ジェネレーターは、型、必須プロパティ、配列要素のスキーマ、date-time、email、uri、uuidなどの一般的な文字列形式を推定し、draft2020-12、2019-09、またはdraft-07のスキーマを作成します。このスキーマを使って、リクエストの検証、APIのドキュメント作成、フォームの生成ができます。
よくある質問
どのJSONスキーマドラフトに対応していますか?
OpenAPI 3.1が使用する現行バージョンのdraft2020-12、draft2019-09、および古い多くのバリデーターやツールが今も必要とするdraft-07に対応しています。選択すると$schemaのURLが設定されます。ジェネレーターが出力するキーワードの意味は、どのドラフトでも同じです。
必須プロパティはどのように決まりますか?
あるオブジェクトのすべてのサンプルに含まれるプロパティは、requiredに記載されます。オブジェクトの配列では、一部の要素にないキーはrequiredから除外されます。オプションをオフにすると、requiredのリストを含まないスキーマを出力できます。
どの文字列形式が検出されますか?
date-time、date、time、email、uri、uuid、ipv4が対象です。プロパティのサンプル値がすべて形式に一致する場合にのみ、その形式が追加されます。自由形式のテキストが1つでもあると、そのプロパティは通常の文字列のままです。形式キーワードを追加しない場合は、検出をオフにしてください。
スキーマでは整数と小数が区別されますか?
はい。サンプルがすべて整数のプロパティは、typeがintegerになります。小数部分のあるサンプルが1つでもあると、typeはnumberになります。numberは整数も受け入れます。
配列はどのように記述されますか?
配列のtypeはarrayになり、すべての要素からitemsスキーマが作成されます。配列内のオブジェクトは統合されるため、itemsスキーマにはどれかの要素に含まれるすべてのキーが記載されます。requiredには、すべての要素にあるキーだけが含まれます。
型が混在している場合はどうなりますか?
プロパティに異なる単純な型の値が含まれる場合、たとえばある要素では文字列、別の要素ではnullの場合、スキーマでは["string", "null"]のような型の配列として記載されます。オブジェクトや配列がほかの型と混在する場合は、ジェネレーターはそれぞれのスキーマを含むanyOfを使います。
additionalPropertiesや制限値は追加されますか?
いいえ。サンプルからは、どの追加キーが禁止されるかや、実際の最小値・最大値は判断できません。そのため、ジェネレーターはadditionalProperties、minLength、maximumなどのキーワードを省略します。データに必要な制約は手動で追加してください。
生成結果でデータを検証できますか?
はい。JSONスキーマバリデーターにスキーマとデータを貼り付けるか、Ajvなどのライブラリで使用してください。スキーマはサンプルを反映したものなので、実際のデータでは省略されたりnullになったりする可能性があるものの、サンプルには含まれていないフィールドがあれば、スキーマを少し編集してください。
OpenAPIでスキーマを使用できますか?
OpenAPI 3.1ではJSON Schema 2020-12を直接使用できるため、$schema行を削除すれば、生成されたスキーマをcomponents/schemasに配置できます。OpenAPI 3.0では古いサブセットが使われるため、型の配列をnullableに置き換えてください。
入力の最大サイズはどれくらいですか?
JSONは最大1,000,000文字で、最大64階層までネストできます。サンプルはこのリクエストのためだけに解析され、保存されません。