OpenAPI デバッグワークフローチェックリスト

順番に切り分ける

まず対象 operation を確定し、path パラメータ、query、headers、body の実データを仕様と揃えて確認します。

契約がずれたままログだけ見ても、原因の切り分けはほとんど進みません。

再現と比較は生データで行う

• 再現可能なツールでリクエストを送信し、headers と body を保存する。
• 実際のステータスコードと schema を仕様と項目単位で比較する。
• 修正後は実装か仕様のどちらかを更新し、契約チェックを再実行する。

実用的な入出力例

spec: POST /orders -> 201
actual: POST /orders -> 200

contract mismatch を検出
対応: サービス実装または仕様のレスポンス定義を修正

おすすめの API ツール