API中心 API Hub-可维护性:API需要保持向后兼容性

时间:2025-02-12 14:54:50

API需要保持向后兼容性

本条规则是MUST类型的基本规则,可保障API的可维护性。

  • 现网API版本一般保留3个版本或以下,如果超过3个版本会增加API本身的维护量,建议对旧版本API进行下线处理。
  • 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户端的契约,不能单方面破坏契约。通过如下的方式来保证向后的兼容性:
    • 遵循兼容扩展标准。
    • 忽略请求/响应中的未知字段。
    • 只添加可选字段,不能添加必选字段。
    • 不能更改字段的含义。
    • 当资源URL发生变化的时候,支持重定向。
    • 服务端提供新版本API的同时,需要对老版本API提供支持。

例如:应用A更新API查询虚拟机列表,增加多个新的查询条件。在API发布之后,之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。

support.huaweicloud.com/productdesc-apihub/apihub_01_0026.html