JSONスキーマジェネレーター
JSONデータからJSONスキーマを自動生成します
JSON入力
生成されたスキーマ
JSONスキーマジェネレーターとは?
APIのデータ構造をドキュメント化したいが、JSONスキーマを手書きしたくないと思ったことはありませんか?このツールがその解決策です。JSON(JavaScript Object Notation)データを貼り付けるだけで、構造・型・検証ルールを記述した完全なスキーマを自動生成します。
APIドキュメント、データ検証、またはJSONの内容を把握するのに最適です。MDN Web Docsが説明するように、JSONスキーマはデータ構造の検証に役立ち、当ジェネレーターはJSONスキーマ公式仕様に準拠しています。ネストされたオブジェクト・配列・複雑な部分もすべて自動で処理します。
最大の特長は、すべてブラウザ内で動作することです。データはコンピューターから出ることはありません。アップロード不要、待ち時間なし、即座にスキーマが生成されます。
JSONスキーマジェネレーターの使い方
JSONデータからJSONスキーマを生成する手順です。各ステップはこのページの実際のボタンとパネルを使用します。
JSONを貼り付けるかファイルをアップロード
左側のJSON入力パネルにJSONを貼り付けるか、アップロードをクリックして.jsonや.txtファイルを読み込んでください。サンプルをクリックするとサンプルデータが表示されます。入力例:
{"subscriberId": "SUB-1001", "plan": "Unlimited 5G", "dataUsage": 45.2, "status": "active"}オブジェクトまたは配列に対応しています。無効なJSONはエラーが表示されます。
生成されたスキーマを確認
右側の生成されたスキーマパネルにスキーマが自動的に表示されます。型(string・number・boolean・object・array)の検出、ネスト構造の処理、必須フィールドとオプションフィールドの識別を行います。JSONスキーマ仕様に準拠しています。両パネルでシンタックスハイライトが使用されています。
コピーまたはダウンロード
コピーをクリックしてスキーマをクリップボードにコピー、またはダウンロードでファイルとして保存できます。Swagger/OpenAPIドキュメントや検証ライブラリでスキーマを使用してください。クリアをクリックすると入力パネルをリセットできます。すべての処理はブラウザで実行されます。
実際の活用シーン
APIドキュメント
APIレスポンスの例がある場合、そこからスキーマを生成してSwagger/OpenAPIドキュメントで使用できます。手書きでスキーマを書くよりはるかに速いです。
データ検証
受信するJSONを検証する必要がある場合、スキーマを生成して検証ライブラリと組み合わせることで、データが期待通りであることを確認できます。
型定義
データ構造を把握するためにスキーマを生成します。複雑なJSON形式のドキュメント化やAPIコントラクトの理解に最適です。
コントラクトテスト
コントラクトテスト用のスキーマを作成します。スキーマ検証を使用してAPIレスポンスが期待される構造と一致することを確認します。
よくある質問
JSONデータは保存されますか?
いいえ。すべてはブラウザ内で処理されます。データはコンピューターから出ることはなく、私たちには見えません。
どのバージョンのJSONスキーマが使用されますか?
JSONスキーマDraft 7以降に対応したスキーマを生成します。公式仕様に準拠しているため、標準的な検証ツールで動作します。
配列にも対応していますか?
もちろんです。配列も問題なく処理されます。オブジェクトの配列がある場合、オブジェクト構造を分析して適切なアイテムスキーマを生成します。
オプションフィールドと必須フィールドの扱いは?
JSONサンプルを分析して毎回登場するフィールドを特定します。それらが必須としてマークされ、時々登場するフィールドはオプションとしてマークされます。
生成されたスキーマを編集できますか?
できます。出力パネルは完全に編集可能なので、型の変更、制約の追加、ニーズに合わせた調整が可能です。
無効なJSONでも動作しますか?
動作しません。まず有効なJSONが必要です。問題がある場合はエラーが表示されます。先にJSONバリデーターまたはJSON修正ツールをお試しください。
他に役立つJSONツール
スキーマ生成は必要な機能のひとつです。組み合わせて使うのに便利な他のツールです: