全部产品

API 版本管理

更新时间:2020-07-21 14:29:30

API 只有在发布后才能被订阅方使用。创建后的 API 可以根据业务需求进行编辑、下线和编辑重发布等操作。新版本发布上线后,老版本自动成为历史版本被下线。

API 版本的生命周期如下:

API 版本管理

版本说明

  • 每次发布一个版本时,系统为当前版本分配一个新的版本号。
  • 每次保存草稿时,系统为未发布草稿分配一个新的版本号。
  • 同一 API 只能存在一个编辑中版本。新保存的草稿自动覆盖未发布的已有草稿。

查看版本

API 管理 页面,点击目标 API 进入其详情页。在 版本管理 标签页下,您可以查看到当前线上版本、编辑中版本以及历史发布版本,如下图所示。

版本管理

发布版本

您可以对线上版本与历史版本重新编辑再发布,也可以直接发布编辑中的版本。

重新编辑并发布线上版本

  1. 版本管理 > 线上版本 中,点击 操作 列的 重新编辑 按钮。
  2. 在编辑页面,修改 API 信息 后,点击 保存
  3. 在 API 编辑的内容保存成功页面,点击 立即发布
  4. 发布 窗口,您可以选择输入具体版本原因,点击 确定,即可发布成功。

发布编辑中版本

  1. 在 版本管理 > 编辑中版本 中,点击 操作 列的 发布 按钮。
  2. 发布 窗口,输入具体版本原因,点击 确定,即可发布成功。

编辑重发布历史版本

  1. 版本管理 > 历史版本 中,点击 操作 列的 编辑重发布 按钮。
  2. 在编辑页面,修改 API 信息 后,点击 保存
  3. 在 API 编辑的内容保存成功页面,点击 立即发布
  4. 发布 窗口,您可以选择输入具体版本原因,点击 确定,即可发布成功。

下线版本

您可以将处于已发布状态的 API 下线。下线后, API 状态切换为 未发布,无法被该 API 的订阅方应用继续调用。您可以通过以下任一方法下线 API 当前版本:

  • 在 API 列表中选择要下线的 API,点击 下线 > 确认
  • 在 API 详情页面,点击右上角的 下线 按钮。
  • 在 API 详情 > 版本管理 页签中,点击 线上版本 右侧的 下线 按钮。