JSONスキーマバリデーター

サポートされているキーワード

コア: type、enum、const、multipleOf、maximum、minimum、exclusiveMaximum、exclusiveMinimum、maxLength、minLength、pattern、maxItems、minItems、uniqueItems、maxContains、minContains、maxProperties、minProperties、required、dependentRequired。

組み合わせ: allOf、anyOf、oneOf、not。

適用キーワード: properties、patternProperties、additionalProperties、items、prefixItems、contains、propertyNames。

条件分岐: if、then、else、dependentSchemas。

参照: $ref、$defs、$id、$anchor。

フォーマット（有効にすると検証を実施）: date-time、date、time、duration、email、hostname、ipv4、ipv6、uri、uuid、regex。

エラー出力

FAIL  /user/email        format            "not-an-email" is not a valid "email"
FAIL  /user/age          minimum           -3 is less than the minimum 0
FAIL  /orders/0/total    type              "42" is not of type "number"
FAIL  /                  required          missing required property "shippingAddress"

すべてのエラーには失敗したパスとキーワードが含まれるため、エディタ内ですばやく特定できます。

落とし穴になりやすいドラフト間の違い

正しいドラフトを設定してください。ドラフト04のスキーマを2020-12として検証すると、idやその他の細かな点が誤って解釈されます。

典型的なワークフロー

• API契約テスト: デプロイ前に、生成または更新したOpenAPIスキーマを実際のサンプルレスポンスに照らして実行します。
• 設定の堅牢化: マージ前に、CIですべてのYAML/JSON設定をスキーマに照らして検証します。
• データ取り込み: 期待する形に合致しないペイロードを、明確なエラーメッセージとともに早い段階で拒否します。

よくある間違い

• formatの適用を忘れる。 デフォルトでは、ほとんどのバリデーターは未知のフォーマットを注釈としてのみ扱います。不正なメールアドレスや日付を実際に拒否するには、厳格なフォーマット検証を有効にしてください。
• oneOfの使いすぎ。 oneOfの2つの分岐が重なると、ドキュメントは失敗します（ちょうど1つだけに一致する必要があります）。anyOfまたはディスクリミネーターのパターンを使用してください。
• additionalProperties: falseによる厳格すぎるスキーマ。 新しい任意フィールドを追加することが互換性を壊す変更になってしまいます。本当に閉じたオブジェクトが必要な場合を除き、指定しないでください。