JSON Schema Generator
JSONデータのサンプルからJSON Schema(Draft-07)を自動生成する無料オンラインツール。
JSONを入力してください...
ネスト・配列・必須項目を自動判定、APIリクエスト/レスポンスのバリデーション定義・OpenAPI仕様書のたたき台・フォーム自動生成の下準備に。手書きの数十行を数秒に、ブラウザ完結で外部送信なし。
JSONのサンプルデータを貼るだけで、そのデータ構造に対応するJSON Schema定義を自動生成するツールです。手書きすると煩雑な型定義を一瞬で作れます。
JSON Schema Generatorの機能と特徴
JSON Schemaとは
JSON Schemaは「このJSONはこういう形をしていないといけない」というルールを定義するための仕様です。
APIのリクエスト/レスポンスが正しい形式か検証したり、フォーム画面を自動生成したり、ドキュメントとして活用したりできます。
多くのAPIツール(Postman、OpenAPI、AJV等)で標準サポートされており、実務でも広く使われています。
手書きせずサンプルから生成する
JSON Schemaを手書きすると、ネストされたオブジェクトごとに properties を書き、型を指定し、required を並べる必要があります。100項目あるオブジェクトなら数百行のスキーマになることもザラ。
本ツールならJSONのサンプルを1つ貼るだけで、対応するスキーマを一気に生成できます。あとは必要に応じて手を加えるだけです。
型の自動判定(string・integer・boolean・array)
次のように自動判定されます。
- 文字列は "string"
- 数値は "integer"(整数)または "number"(小数含む)
- 真偽値は "boolean"
- null は "null"
- 配列は "array"
- オブジェクトは "object"
ネストされた構造も再帰的に解析するので、複雑なAPIレスポンスでもワンクリックでスキーマ化できます。
OpenAPI(Swagger)にそのまま転記できる
OpenAPI(Swagger)の仕様書を書くときも、components/schemas 部分は JSON Schema と同じ書き方です。
実際のAPIレスポンスを本ツールに貼ってスキーマを作れば、そのままOpenAPIに転記できるので、仕様書作成の効率が大きく上がります。
JSONの型からTypeScriptを作りたい場合は JSON→TypeScript型生成 をご利用ください。
JSON Schema Generatorに関するよくある質問
生成されたスキーマはそのまま使えますか?
基本的な形は正しく生成されるので、そのままバリデーションに使えます。
ただし次のような細かい制約は元のJSONから推測できないため、必要に応じて手動で追加してください。
- min/max(最小/最大値)
- pattern(正規表現)
- format(日付・メール等)
生成されたスキーマは Ajv・OpenAPI・Postman・多くのライブラリで使えます。
配列の中身はどう判定されますか?
配列の全要素を見て、共通する型を推論して items として定義します。
例えば
["a", "b", "c"]なら{"type": "array", "items": {"type": "string"}}に、[1, "a"]のように型が混在する場合は oneOf でユニオン型として表現します。実データに基づく判定なので、実際のAPIレスポンスから正確なスキーマが作れます。
必須項目(required)はどう決められますか?
オブジェクト直下の全プロパティはデフォルトで required(必須)として生成されます。
ただし配列内のオブジェクトについては、「全要素に共通するプロパティのみが必須、一部にしかないプロパティは任意」として扱われます。
実データから「必ずある/たまにない」を判定できるので、より現実的なスキーマになります。
JSON Schema Generatorの使い方
-
もとになるJSONを貼り付け
左側の入力欄にJSONデータを貼り付けます。実際のAPIレスポンス・設定ファイル・データベース出力など、リアルなデータを使うほど実用的なスキーマになります。
-
タイトルとインデントを指定
「タイトル」欄でスキーマの名前を、「インデント」で整形幅を選びます。デフォルトのままでも問題なく使えます。
-
生成されたスキーマをコピー
右側にJSON Schema がリアルタイムで表示されます。「コピー」ボタンでクリップボードに保存し、Ajv・OpenAPI仕様書・Postmanなど、スキーマを使う各種ツールに貼り付けて活用してください。
カテゴリ データ形式