最后更新:
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的移动应用程序