教程:使用修订安全地进行非中断性 API 变更

当 API 准备就绪并可供开发人员使用时,你最终需要对该 API 进行更改,同时避免干扰 API 的调用方。 另一种有效的做法是让开发人员知道所做的更改。

在 Azure API Management 中,使用修订进行非中断性 API 变更,以便可以安全地对变更进行建模和测试。 准备就绪后,可以将修订设为当前版本并替换当前的 API。

有关背景知识,请参阅版本和修订使用 Azure API Management 进行 API 版本控制

本教程介绍如何执行下列操作:

  • 添加新的修订版
  • 对修订版进行非重大更改
  • 将修订版设为当前版本并添加更改日志项目
  • 浏览开发人员门户以查看更改与更改日志

API revisions in the Azure portal

先决条件

添加新的修订版

  1. 登录到 Azure 门户,并转到你的 API 管理实例。

  2. 选择“API”。

  3. 从 API 列表中选择“演示会议 API”(或想要添加修订的其他 API)。

  4. 选择“修订”选项卡。

  5. 选择“+ 添加修订”。

    Add API revision

    提示

    也可以在 API 上的上下文菜单 (…) 中选择“添加修订” 。

  6. 提供新修订版的说明,帮助记住其用途。

  7. 选择“创建”。

  8. 现已创建新的修订版。

    注意

    原始 API 保留在“修订版 1”中。 这是在将其他修订版设为当前版本之前,用户继续调用的修订版。

对修订版进行非重大更改

  1. 从 API 列表中选择“演示会议 API”

  2. 选择靠近屏幕顶部的“设计”选项卡。

  3. 请注意,修订版选择器(位于“设计”选项卡正上方)显示“修订版 2”为当前所选项。

    提示

    使用修订版选择器可在要使用的修订版之间切换。

  4. 选择“+ 添加操作”。

  5. 将新操作设置为“POST”,将操作的“名称”、“显示名称”和 URL 设置为“test”。

  6. 保存新操作。

    Modify revision

  7. 现在,已对“修订版 2”进行了更改。 使用靠近页面顶部的“修订版选择器”切换回到“修订版 1” 。

  8. 请注意,新操作不会出现在“修订版 1”中。

将修订版设为当前版本并添加更改日志项目

  1. 在靠近页面顶部的菜单中选择“修订”选项卡。

  2. 打开“修订版 2”对应的上下文菜单 (...)。

  3. 选择“设为当前版本”。

  4. 如果想要发布有关此变更的说明,请选中“发布有关此 API 的公共变更日志”复选框。 提供可让开发人员看到的更改说明,例如:“测试修订。添加了新的‘测试’操作”。

  5. 修订版 2 现在是当前版本。

    Revision menu in Revisions window

浏览开发人员门户以查看更改与更改日志

如果已尝试使用开发人员门户,则可以查看 API 变更和这里的变更日志。

  1. 在 Azure 门户中,选择“API”。
  2. 在顶部菜单中选择“开发人员门户”。
  3. 在开发人员门户中,选择“API”,然后选择“演示会议 API” 。
  4. 请注意,新的“测试”操作现已显示。
  5. 选择 API 名称旁边的“Changelog”。
  6. 请注意,你的更改日志条目已显示在列表中。

后续步骤

在本教程中,你了解了如何执行以下操作:

  • 添加新的修订版
  • 对修订版进行非重大更改
  • 将修订版设为当前版本并添加更改日志项目
  • 浏览开发人员门户以查看更改与更改日志

转到下一教程: