2026-05-18 · 読了目安 1 分
リリース前に OpenAPI を検証する
壊れたコントラクトを早期に検出 — 欠落パス、info ブロック、バージョンのずれ。
OpenAPIAPICI
重要ポイント
- 構造検証はレスポンススキーマテストの代わりにはならない — ただし明らかな出荷阻止要因は防げる。
- サービスごとに正本の spec ファイルを1つ保持; 公開する同一成果物を検証する。
CI で検証する理由
壊れた spec は codegen、ドキュメントポータル、API ゲートウェイを連鎖的に壊す。
paths オブジェクト欠落が本番ドキュメントに出荷される前の構造チェックは、数時間の節約になる。
ワークフロー
機能ブランチをマージした後、JSON または YAML を OpenAPI Validator に貼り付ける。
有効なら、同じベース URL と認証で HTTP Request から重要パスをスポットチェック。
よくある質問
レスポンス例も検証しますか？
トップレベルのコントラクト形状をチェック; ペイロード例とステータスコードには契約テストを追加。
Swagger 2.0 はサポートされますか？
基本的な構造チェックは適用; 可能なら OpenAPI 3 へ移行してより豊富なツールを利用。