Versioning API: `/v1/`, `Accept: version`, `GraphQL alias`

隨著API的發展,出現了新的方法,參數和邏輯。為了不幹擾當前客戶的操作,應用了API驗證。我們支持多種版本化方法,允許集成商使用所需的界面版本,而無需承擔穩定操作的風險。

這在擴展平臺以及實施更新、測試或為舊客戶服務時都很重要。


轉換方法

方法描述和好處
URL中的版本('/v1/')最容易理解和流行的方法-方便使用REST API
接受標題示例:"接受:application/vnd。api+json;version=2'-將數據與版本分開
GraphQL alias / versioned fields通過aliasas不同版本:「userV1」、「userV2」-方便逐步遷移
模式級版本每個版本的OpenAPI/Swagger中的各個電路和模塊

如何實現

具有'/v1/'、'/v2/'和獨立路由的API結構

「接受」和「X-API-Version」標題驗證'
  • GraphQL支持alias和轉換電路(「userV1」,「userV2」)
  • A/B測試新版本的能力,沒有生產風險
  • 對每個版本進行搜索以進行分析和遷移

業務和集成商優勢

支持老客戶不減慢發展速度
  • 多代API並行
  • 安全實施新功能而不中斷向後兼容性
  • 靈活擴展和升級基礎架構
  • 通過控制和分析在版本之間進行透明遷移

在哪裏,特別重要

具有眾多外部客戶的平臺
  • 具有API第一方法和長生命周期的項目
  • 與銀行、供應商、B2B合作夥伴集成
  • 具有長壽命移動或IoT客戶端的系統

API驗證是集成可靠性和靈活性的基礎。無論格式如何(REST、GraphQL或gRPC),我們都確保安全地開發接口-無中斷、沖突或互操作性損失。

聯繫我們

請填寫下方表格,我們將盡快與您聯繫。