使用修订安全做出非重大更改

当 API 准备就绪并即将供开发人员使用时,你最终需要对该 API 进行更改,同时避免干扰 API 的调用方。 另一种有效的做法是让开发人员知道所做的更改。 可以在 Azure API 管理中使用修订实现此目的。 有关详细信息,请参阅版本和修订以及使用 Azure API 管理进行 API 版本控制

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

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

开发人员门户上的更改日志

先决条件

添加新的修订版

  1. 选择“API”页。
  2. 从 API 列表中选择“演示会议 API”(或想要添加修订的其他 API)。
  3. 在靠近页面顶部的菜单中单击“修订”选项卡。
  4. 选择“+ 添加修订版”

    Tip

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

    靠近屏幕顶部的“修订”菜单

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

  6. 选择“创建”
  7. 现已创建新的修订版。

    Note

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

对修订版进行非重大更改

  1. 从 API 列表中选择“演示会议 API”。
  2. 选择靠近屏幕顶部的“设计”选项卡。
  3. 请注意,修订版选择器(紧靠在“设计”选项卡的上方)显示当前修订版为“修订版 2”。

    Tip

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

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

  5. 将新操作设置为“POST”,将操作的“名称”、“显示名称”和 URL 设置为“test”。
  6. 保存新操作。
  7. 现已对修订版 2 进行更改。 使用靠近页面顶部的修订版选择器切换回到修订版 1
  8. 请注意,新操作未出现在“修订版 1”中。

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

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

    修订屏幕上的修订菜单。

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

  3. 选择“设为当前版本”。
  4. 如果想要发布有关此更改的说明,请选中“发布有关此 API 的公共更改日志”。 提供可让开发人员看到的更改说明,例如,“测试修订。添加了新的“测试”操作。
  5. 修订版 2 现在是当前版本。

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

  1. 在 Azure 门户中,选择“API”。
  2. 在顶部菜单中选择“开发人员门户”。
  3. 依次选择“API”、“演示会议 API”。
  4. 请注意,新的“测试”操作现已显示。
  5. 选择 API 名称下面的“API 更改历史记录”。
  6. 请注意,更改日志项目已显示在此列表中。

    开发人员门户

后续步骤

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

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

转到下一教程: