API中心 API Hub-生命周期管理:API文档记录API接口变更

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

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功能。
support.huaweicloud.com/productdesc-apihub/apihub_01_0031.html