最后更新:
Versioning API: `/v1/`, `Accept: version`, `GraphQL alias`
Click to expand / collapse

随着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),我们都确保安全地开发接口-无中断、冲突或互操作性损失。

热门主题


主要主题