專題 C1:JSON 生態
JSON Schema 驗證檢查清單
在 API 或設定變更上線前,以可執行的 JSON Schema 檢查清單統一欄位約束、範例與回歸驗證。
先把資料契約寫清楚
Schema 的價值不只是能不能通過驗證,而是讓團隊對必填欄位、可空欄位與列舉值範圍有一致理解。
如果文件、範例資料與實際驗證規則不一致,問題通常會在聯調或發佈前後才集中暴露。
發布前至少檢查這些點
- 確認 required、type、enum、format 與真實介面限制一致。
- 為巢狀物件與陣列準備至少一組成功樣例與一組失敗樣例。
- 把 Schema 驗證納入 CI,避免只靠人工審查發現回歸。
實用輸入/輸出範例
輸入
{
"type": "object",
"required": ["id", "status"],
"properties": {
"id": { "type": "string" },
"status": { "enum": ["ready", "failed"] }
}
}輸出
驗證結果: - payload.id 缺失時失敗 - payload.status 只能是 ready / failed