JSONスキーマジェネレーター

JSONスキーマジェネレーターは、サンプルJSONをAPI、ウェブフック、設定ファイル、データパイプライン、およびドキュメント用のバリデータ対応スキーマに変換します。代表的なJSONオブジェクト、配列、またはNDJSONフィードを貼り付けて推論スタイルを選択するだけで、ツールがネストされたプロパティ、配列アイテムのルール、nullable値、例、および読みやすいパスごとのノートを含むスキーマを構築します。

サンプルベースのJSONスキーマジェネレーターを使用する理由

JSON Schemaを手動で作成するのは正確ですが、特にデータにネストされたオブジェクト、レコードの配列、オプションのフィールド、およびnullable値が含まれている場合は時間がかかります。このジェネレーターは、JSONデータの観察された形状を捉えた構造化された最初のドラフトを提供し、人間のレビューがまだ必要な部分をハイライトします。APIリクエストのバリデーション、レスポンスの契約、OpenAPIの作業、ウェブフックのペイロード、イベントストリーム、および設定スキーマに役立ちます。

使用方法

1. 代表的なJSONオブジェクト、JSON配列、または改行区切りのJSON（NDJSON）レコードをサンプルエディタに貼り付けます。
2. JSON Schemaのドラフトを選択し、必須フィールド、例、enumのヒント、文字列フォーマット、および閉じられたオブジェクトを推論するかどうかを決定します。デフォルトでは、ドラフトは Draft 2020-12 で、必須フィールドは「すべてのオブジェクトで観察」、「フォーマットを検出」、「例（examples）を含める」、「enumのヒントを推論」がオンで、「閉じられたオブジェクト」はオフになっています。スキーマのタイトルは GeneratedSchema から始まります。
3. 「JSON Schemaを生成」をクリックして、型、ネストされたプロパティ、配列アイテム、nullableフィールド、およびバリデーションのヒントを推論します。
4. スキーマを使用する前に、生成されたマップをチェックして、各パス、推論された型、必須ステータス、フォーマット、およびルールを確認します。
5. 生成されたスキーマをコピーし、正確な範囲、IDパターン、ビジネス固有のenumなど、ドメイン固有のバリデーションルールを洗練させます。

ジェネレーターが推論するもの

• 主要なJSON型: object、 array、 string、 number、 integer、 boolean、 および null。
• 観察されたすべてのオブジェクトに表示されるものに基づく、ネストされたオブジェクトのプロパティと必須フィールド。
• サンプル内の観察されたアイテムをマージすることによる配列アイテムのスキーマ。
• メール、URL、日付、日時、UUID、IPv4、およびIPv6を含む一般的な文字列フォーマット。
• オプションの例、enumのヒント、観察された数値範囲、および観察された文字列の長さ。

FAQ

このJSONスキーマジェネレーターは何をしますか？

サンプルJSONを読み取り、観察されたデータの形状を記述するJSON Schemaを作成します。ジェネレーターは、オブジェクトのプロパティ、配列、プリミティブ型、nullable値、例、enumのヒント、必須フィールド、および一般的な文字列フォーマットを推論します。

生成されたスキーマはすぐに本番環境で使用できますか？

強力な出発点として使用し、その後レビューしてください。サンプルデータだけではすべてのビジネスルールを把握することはできないため、パターン、正確な範囲、許可されたenum値、バージョンルール、およびより厳格なadditionalPropertiesの設定を追加する必要がある場合があります。

どのJSON Schemaドラフトがサポートされていますか？

このツールは、$schema URIを設定することで、Draft 2020-12、Draft 2019-09、およびDraft-07用のスキーマを生成できます。推論される構造は、一般的なバリデータと互換性を持つように意図的に設計されています。

必須フィールドはどのように推論されますか？

必須項目の推論が有効な場合、そのレベルのすべての観察されたオブジェクトにプロパティが存在する場合にのみ、必須（required）としてマークされます。オブジェクトの配列の場合、サンプリングされたすべてのアイテムにそのフィールドが含まれている必要があることを意味します。

このツールはオブジェクトの配列やNDJSONをサポートしていますか？

はい。トップレベルのJSON配列は配列スキーマとして処理され、改行区切りのJSONレコード（NDJSON）はレコードの配列として処理されます。アイテムのプロパティは、観察されたサンプルからマージされます。