JSON API データ契約設計の要点
出荷後に変えるのが非常に難しい六つ。レスポンスエンベロープ、エラー形式、ページネーションの形、ID と時刻の表現、null と欠落の意味論、バージョン進化です。
中級約 13 分で読めます2026-10-30 更新
JSON を実際のシステムに組み込む方法。API 契約の定義、設定とフィクスチャの管理、バージョン互換性の扱い、テストデータの維持を扱います。
5 件の記事出荷後に変えるのが非常に難しい六つ。レスポンスエンベロープ、エラー形式、ページネーションの形、ID と時刻の表現、null と欠落の意味論、バージョン進化です。
設定は階層化して検証しなければならず、フィクスチャは決定的で読みやすく差分可能でなければなりません。この二種類のファイルの管理が下手だと、トラブルシューティングのコストが長く高止まりします。
50 件が 51 件になると、差分ツールは 51 件の変更を報告します。テキスト差分の誤検知、id による配列の照合、jq の正規化、適用可能なパッチを扱います。
merge=union は壊れた JSON を通し、しかも成功と報告します。キーを理解する JSON 用の三方向マージドライバと、競合を減らす三つの習慣を解説します。
フィールドの追加は自動的に安全ではありません。互換性の境界、バージョンフィールド、非推奨の期間、二重書き込みの移行、契約テスト、カナリア指標を扱います。