為了安全且可預測地運行API，必須嚴格控制接收和返回的數據。我們實施了JSON Schema支持-一種正式的數據結構描述,允許在服務器和客戶端自動驗證請求和響應。
JSON Schema有助於識別集成階段的錯誤，消除不穩定的行為，確保系統之間的互操作性，並提高與API的互操作性。
JSON Schema給出的內容
| 一個機會 | 提供什麼 |
|---|---|
| 結構驗證 | 確保對象符合預期的字段和類型 |
| 必填字段 | 控制關鍵屬性的存在 |
| 類型化 | 清晰檢查數字、行、布爾和數組 |
| 限制和格式 | 支持最小/最大長度,enum,模式,電子郵件格式等。 |
| 重復使用 | 創建模板和重新使用的組件 |
驗證如何工作
1.請求或響應與預定義的模式進行比較
2.如果存在偏差-API返回帶有解釋的錯誤
3.可以組合、繼承、使用條件規則
4.適用於任何級別： 查詢、主體、標題、查詢參數
對API和客戶的好處
防止錯誤和惡意數據
提高整合穩定性和行為可預測性
基於電路的自動測試和莫克生成
在文檔和Swagger/OpenAPI中使用模式的能力
簡化API支持和擴展
特別相關的地方
具有外部集成和合作夥伴API的平臺
移動和前端應用程序等待明確的響應結構
帶有自動API測試的CI/CD pipline
具有動態可變參數和合同的系統