專題 C2:API 偵錯
OpenAPI 偵錯流程檢查清單
很多 API 故障不是程式碼壞掉,而是規格、客戶端與服務實作之間對契約理解不一致。
按順序排查,不要跳步
先確認命中了哪個 operation,再核對 path 參數、query、headers 與 request body 的真實結構。
如果連目標契約都沒對準,就直接翻服務日誌,通常只會越看越亂。
重播與比對要看原始資料
- 用可重複工具重播請求,保留原始 headers 與 body。
- 把真實狀態碼與 schema 跟規格逐項比對,而不是只看成功或失敗。
- 修正後同步更新實作或規格,再跑一次契約檢查。
實用輸入/輸出範例
輸入
spec: POST /orders -> 201 actual: POST /orders -> 200
輸出
發現 contract mismatch 動作:修正服務實作或更新規格中的狀態碼