更新时间:2023-09-27 GMT+08:00
分享

生命周期管理

API接口变更在参考文档中为新版本提供迁移计划

本条规则是Should类型的扩展规则,可方便管理API的生命周期。

在进行新版本API设计时应当考虑老版本升级迁移计划,从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。

  • 对于计划不再支持的接口,需要正式发布接口变更公告,应当至少提前6个月在文档标识(使用@deprecated)为不建议使用(在此期间该接口仍要能完成正常的功能),并提供替换方式的处理。
  • 新版本API为兼容旧版本,增加的字段不建议作为强制填写的字段,字段取值范围不建议小于原有的取值范围。

API文档记录API接口变更

本条规则是Should类型的扩展规则,可方便管理API的生命周期。

API接口的变更,要具体到参数级别,必须将API修订的记录按照时间和版本顺序排列进行条目化,具体示例如表1所示。
表1 API修订记录

时间

版本

变更内容

2021-07-15

V1.0

XXX服务API初始发布

2021-09-20

V1.1

  1. XXX的API,增加XXX字段,用于XXXX功能;增加XXX字段,用于XXX功能。
  2. XXX的API,增加XXX字段,用于XXX功能。

API下线前必须提前通知订阅服务的用户

本条规则是MUST类型的基本规则,可保障API租户的业务连续性。

对于需要下线的API,需要梳理订阅该API的用户,并通过公告等方式向订阅API的用户进行提醒。通知需要在服务下线前至少6个月启动,并在公告服务下线时间后1个月内对API调用进行监控,当没有API调用流量之后,才启动正式下线。待该API到了正式下线后,API中心不再展示下线的API。

相关文档