最後更新:
Click to expand / collapse
當API積極開發時,重要的是要保持版本之間的兼容性,並避免單個更改破壞數十個客戶端集成的情況。我們實施全面的合同認證,使您能夠監控更改並順利更新API而不會給用戶帶來風險。
這在微服務體系結構,B2B集成和開源API產品中至關重要,其中不同的客戶端使用不同版本的接口。
我們相信什麼
| 對象 | 說明說明 |
|---|---|
| OpenAPI規範 | 儲存每一份文件和合同 |
| Endpoint'ы | 我們將版本添加到URL ('/v1/', '/v2/'),讓我們保留後端兼容性 |
| 合同(Pact、Dredd) | 提交客戶端與服務器之間的交互條件 |
| 數據模型 | 控制請求和響應結構的變化 |
我們如何實現
並行支持多個API版本
在URL、標題或選項中明確指定版本
自動測試每個版本的合同(Pact、Postman、Jest、Dredd)
在Git中或通過CI/CD驗證規格
每次更改時為客戶提供的文檔和changelog
優點
保證集成穩定性
能夠在沒有「打破」客戶風險的情況下發布新的菲奇
簡化版本之間的遷移
清晰的變更歷史和合同控制
外部和內部開發團隊的透明度
在哪裏,特別重要
具有多種依賴性的微服務體系結構
具有公共或B2B API的平臺
具有長期合同的金融和支付系統
依賴於穩定API的移動應用程序