JSON Schemaジェネレーターとは?

サンプルデータからJSON Schemaを作成します。APIレスポンス、設定ファイル、データベースのエクスポートデータなどのサンプルを貼り付けると、その構造を表すスキーマが生成されます。各値の型、各オブジェクトのプロパティ、各配列の要素の形式、必須プロパティがわかります。APIドキュメント、OpenAPI仕様、フォーム検証、データコントラクトをすぐに作成する際に便利です。生成後、必要に応じて手動で調整できます。

使用方法

  1. 入力欄にサンプルJSONを貼り付けるか入力します。
  2. $schema行に使用するJSON Schemaのドラフトを選択します。Draft 2020-12またはDraft 7を選べます。
  3. プロパティを必須としてマークするかどうかを選択します。
  4. スキーマをコピーするか、schema.jsonとしてダウンロードします。

サンプルが有効なJSONでない場合は、問題のある行と列が表示され、その箇所が示されます。

スキーマの生成方法

  • 各値にはJSONの型が割り当てられます。string、boolean、null、object、arrayのほか、整数にはinteger、小数を含む数値にはnumberが使われます。整数と小数が混在する配列には、両方を表せるnumberが使われます。
  • オブジェクトでは、各キーにpropertiesエントリが作成され、サンプルに含まれる範囲で同じ方法で記述されます。
  • 配列には、すべての要素に適合するitemsスキーマが1つ作成されます。要素がオブジェクトの場合は、それぞれのプロパティが統合されるため、レコードのリストから1つのレコード用スキーマが作成されます。
  • 型が混在する値には、["string", "null"]のようにすべての型がリストで指定されます。オブジェクトとほかの値が混在する場合は、anyOfが使われます。
  • 空の配列には、説明する要素がないため、itemsを含めずに"type": "array"が設定されます。

必須プロパティ

「プロパティを必須としてマーク」をオンにすると、各オブジェクトのキーがrequiredに列挙されます。オブジェクトの配列では、すべての要素に含まれる場合に限り、そのプロパティが必須になります。たとえば、一部の要素にしかfavoriteがないメンバーのリストでは、そのプロパティは任意です。このオプションをオフにすると、requiredのリストを含まないスキーマが生成されます。

サンプルからはわからないこと

1つのサンプルから生成したスキーマでわかるのは、そのサンプルに示されていることだけです。文字列がメールアドレスや日付かどうか、数値が取り得る範囲、1度だけ現れたプロパティが省略されることもあるかどうかは判断できません。必要に応じてformat、minimum、maxLength、enum、patternを手動で追加し、JSON Schemaバリデーターでデータを検証してください。

仕組み

このツールは、GenSONスキーマビルダーをJavaScriptに移植したgenson-jsを使用しています。出力されるキーワードはDraft 7とDraft 2020-12で同じ意味を持つため、ドラフトを変更しても変わるのは$schema行だけです。すべてブラウザー内で処理され、サンプルがアップロードされることはありません。

機能

  • 任意のサンプルJSONからJSON Schemaを生成
  • 型、ネストされたオブジェクト、配列を自動判定
  • 配列の要素を1つのスキーマに統合し、任意プロパティを特定
  • Draft 2020-12またはDraft 7に対応
  • 必須プロパティの設定を切り替え可能
  • schema.jsonとしてコピーまたはダウンロード
  • ブラウザー内で動作