クラスター C1: JSON エコシステム
JSON Schema バリデーションチェックリスト
API や設定変更を出す前に、JSON Schema を使って必須項目、例、回帰確認を揃えるための実務チェックリストです。
契約を先に固定する
Schema は単にバリデーターを通すためではなく、必須項目、null 許容、列挙値をチームで共有するためにあります。
仕様書、サンプル、実際の検証ルールがずれると、問題は実装後ではなく結合やリリース直前に表面化しやすくなります。
最低限見るべき項目
- required、type、enum、format が実際の API 制約と一致しているか確認する。
- ネストした object や配列に対して成功例と失敗例を 1 つ以上用意する。
- Schema 検証を CI に入れ、レビュー時の見落としを減らす。
実用的な入出力例
入力
{
"type": "object",
"required": ["id", "status"],
"properties": {
"id": { "type": "string" },
"status": { "enum": ["ready", "failed"] }
}
}出力
検証結果: - payload.id がない場合は失敗 - payload.status は ready / failed のみ許可