專題 C1:JSON 生態
API 請求前 JSON 驗證指南
在送出請求前先做 JSON 格式化、Schema 驗證與樣例比對,能明顯降低 API 偵錯成本。
為什麼要在送出前驗證
許多 API 錯誤表面上像後端故障,實際根因卻是請求體欄位遺漏、型別錯誤或語法損壞。
在本地先跑一次格式化與驗證,通常比直接翻網關日誌更快找到問題。
建議的送出前檢查
- 先格式化 payload,確認結構與巢狀層級正確。
- 用 Schema 或欄位規則檢查 required、type 與 enum。
- 把即將送出的內容與已知成功樣例做一次 diff,比對欄位名稱與預設值。
實用輸入/輸出範例
輸入
{"status":"ready","meta":{"retry":"3"}}輸出
送出前發現: - retry 應為 number,不應是 string - payload 需要補上 id