コンテンツへスキップ
uencoder

サンプルデータから JSON Schema を推論する

JSON インスタンスの構造を記述する JSON Schema を生成し、バリデーションとドキュメントに活用します。

  1. 1

    JSON Schema は JSON データの形(必須フィールド、型、形式、制約)を記述します。サンプルデータからスキーマを推論すると、スキーマを手書きせずに検証契約とドキュメントが得られます。

  2. 2
    JSON スキーマジェネレーター →

    JSON インスタンス(理想としては全フィールドが埋まったもの)を貼り付けます。ツールは型、必須プロパティ、配列要素の型を推論し、JSON Schema(draft 2020-12)を出力します。

  3. 3
    JSON バリデーター →

    生成されたスキーマに対して他のインスタンスを検証し、適合することを確認します。不一致は、欠落・余分・誤型のフィールドを明らかにします。

よくある質問

スキーマが緩すぎます。制約を追加するには?
推論されたスキーマは観測された型を捉えますが、ビジネスルールは捉えません。制約を手動で追加してください。文字列形式(date-time、email)、数値の最小/最大、文字列の minLength/maxLength、enum 値、そして未知のフィールドを拒否する additionalProperties: false です。
サンプルは 1 つと多くのどちらから推論すべきですか?
多くからです。単一サンプルはオプションフィールド(そのインスタンスに存在しないフィールドが必須になる)とユニオン型(null になることがあるフィールド)を見逃します。複数のインスタンスを与えるか、推論後にフィールドを手動でオプションにしてください。

このタスクを解決するワークフロー

関連ツール