发布 API 的多个版本

有时,让 API 的所有调用方都使用完全相同的版本是不切实际的。 如果调用方想要升级到更高的版本,他们会希望以一种易于理解的方法实现此目的。 在 Azure API 管理中使用版本即可实现此目的。 有关详细信息,请参阅版本和修订

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

  • 将新版本添加到现有 API
  • 选择版本方案
  • 将版本添加到产品
  • 浏览开发人员门户以查看版本

开发人员门户上显示的版本

先决条件

添加新版本

API 上下文菜单 - 添加版本

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

  2. 选择它旁边的上下文菜单 (...)。

  3. 选择“+ 添加版本”。

    Tip

    也可以在首次创建新 API 时启用版本 - 在“添加 API”屏幕上选择“对此 API 进行版本控制?”。

选择版本控制方案

在 Azure API 管理中,可以选择调用方指定其所需 API 版本的允许方式。 通过选择“版本控制方案”可指定要使用的 API 版本。 此方案可以是路径、标头或查询字符串。 在下面的示例中,路径用于选择版本控制方案。

“添加版本”屏幕

  1. 保留选择“路径”作为版本控制方案

  2. 在“名称”字段中键入 demo-conference-api-v1

    Note

    版本实际上是基于 API 修订版的新 API。 名称是新 API 的名称,必须在 API 管理实例中是唯一的。

  3. 在“版本标识符”字段中键入 v1

    Tip

    如果选择“标头”或“查询字符串”作为版本控制方案,需要提供附加的值 - 标头或查询字符串参数的名称。

  4. 选择“创建”设置新版本。

  5. 在“API 列表”中的“演示会议 API”下面,现在会出现两个不同的 API -“原始”和“v1”。

    Azure 门户中 API 下面列出的版本

    Note

    如果为不受版本控制的 API 添加了版本,则会自动创建“原始”API - 这是对默认 URL 的响应。 这可以确保所有现有调用方不会被添加版本的过程中断。 如果在一开始就启用了版本的情况下创建新 API,则不会创建“原始”API。

  6. 现在,可以编辑和配置“v1”使其作为与“原始”API 不同的独立 API。 对一个版本进行更改不会影响另一个版本。

将版本添加到产品

要使调用方看到新版本,必须将该版本添加到产品

API 管理产品

  1. 从经典部署模型页选择“产品”。
  2. 选择“不受限制”。
  3. 选择“API”。
  4. 选择“设置” (应用程序对象和服务主体对象)。
  5. 选择“演示会议 API,版本 v1”。
  6. 单击“选择”。

浏览开发人员门户以查看版本

  1. 在顶部菜单中选择“开发人员门户”。

  2. 选择“API”,请注意,“演示会议 API”显示了“原始”和“v1”版本。

  3. 选择“v1”。

  4. 请注意列表中第一个操作的“请求 URL”。 其中显示 API URL 路径包含“v1”。

    API 上下文菜单 - 添加版本

后续步骤

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

  • 将新版本添加到现有 API
  • 选择版本方案
  • 将版本添加到产品
  • 浏览开发人员门户以查看版本

转到下一教程: