发布 API 的多个版本Publish multiple versions of your API

有时,让 API 的所有调用方都使用完全相同的版本是不切实际的。There are times when it is impractical to have all callers to your API use exactly the same version. 如果调用方想要升级到更高的版本,他们会希望以一种易于理解的方法实现此目的。When callers want to upgrade to a later version, they want to be able to do this using an easy to understand approach. 在 Azure API 管理中使用版本即可实现此目的。It is possible to do this using versions in Azure API Management. 有关详细信息,请参阅版本和修订For more information, see Versions & revisions.

本教程介绍如何执行下列操作:In this tutorial, you learn how to:

  • 将新版本添加到现有 APIAdd a new version to an existing API
  • 选择版本方案Choose a version scheme
  • 将版本添加到产品Add the version to a product
  • 浏览开发人员门户以查看版本Browse the developer portal to see the version

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

先决条件Prerequisites

添加新版本Add a new version

API 上下文菜单 - 添加版本

  1. 从 API 列表中选择“演示会议 API”。Select Demo Conference API from the API list.

  2. 选择它旁边的上下文菜单 (...)。Select the context menu (...) next to it.

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

    Tip

    也可以在首次创建新 API 时启用版本 - 在“添加 API”屏幕上选择“对此 API 进行版本控制?”。Versions can also be enabled when you first create a new API - select Version this API? on the Add API screen.

选择版本控制方案Choose a versioning scheme

在 Azure API 管理中,可以选择调用方指定其所需 API 版本的允许方式。Azure API Management allows you to choose the way in which you allow callers to specify which version of your API they want. 通过选择“版本控制方案”可指定要使用的 API 版本。You specify which API version to use by selecting a versioning scheme. 此方案可以是路径、标头或查询字符串This scheme can be either path, header or query string. 在下面的示例中,路径用于选择版本控制方案。In the following example, path is used to select the versioning scheme.

“添加版本”屏幕

  1. 保留选择“路径”作为版本控制方案Leave path selected as your versioning scheme.

  2. 在“名称”字段中键入 demo-conference-api-v1Type demo-conference-api-v1 in the Name field.

    Note

    版本实际上是基于 API 修订版的新 API。Version is in fact a new API based off an API's revision. 名称是新 API 的名称,必须在 API 管理实例中是唯一的。Name is the new API's name and it must be unique across API Management instance.

  3. 在“版本标识符”字段中键入 v1Type v1 in the Version identifier field.

    Tip

    如果选择“标头”或“查询字符串”作为版本控制方案,需要提供附加的值 - 标头或查询字符串参数的名称。If you select header or query string as a versioning scheme, you need to provide an additional value - the name of the header or query string parameter.

  4. 选择“创建”设置新版本。Select Create to set up your new version.

  5. 在“API 列表”中的“演示会议 API”下面,现在会出现两个不同的 API -“原始”和“v1”。Underneath Demo Conference API in the API List, you now see two distinct APIs - Original, and v1.

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

    Note

    如果为不受版本控制的 API 添加了版本,则会自动创建“原始”API - 这是对默认 URL 的响应。If you add a version to a non-versioned API, an Original will be automatically created - responding on the default URL. 这可以确保所有现有调用方不会被添加版本的过程中断。This ensures that any existing callers are not broken by the process of adding a version. 如果在一开始就启用了版本的情况下创建新 API,则不会创建“原始”API。If you create a new API with versions enabled at the start, an Original is not created.

  6. 现在,可以编辑和配置“v1”使其作为与“原始”API 不同的独立 API。You can now edit and configure v1 as an API that is separate to Original. 对一个版本进行更改不会影响另一个版本。Changes to one version do not affect another.

将版本添加到产品Add the version to a product

要使调用方看到新版本,必须将该版本添加到产品In order for callers to see the new version, it must be added to a product.

API 管理产品

  1. 从经典部署模型页选择“产品”。Select Products from the classic deployment model page.
  2. 选择“不受限制”。Select Unlimited.
  3. 选择“API”。Select APIs.
  4. 选择“设置” (应用程序对象和服务主体对象)。Select Add.
  5. 选择“演示会议 API,版本 v1”。Select Demo Conference API, Version v1.
  6. 单击“选择”。Click Select.

浏览开发人员门户以查看版本Browse the developer portal to see the version

  1. 在顶部菜单中选择“开发人员门户”。Select Developer Portal from the top menu.

  2. 选择“API”,请注意,“演示会议 API”显示了“原始”和“v1”版本。Select APIs, notice that Demo Conference API shows Original and v1 versions.

  3. 选择“v1”。Select v1.

  4. 请注意列表中第一个操作的“请求 URL”。Notice the Request URL of the first operation in the list. 其中显示 API URL 路径包含“v1”。It shows that the API URL path includes v1.

    API 上下文菜单 - 添加版本

后续步骤Next steps

本教程介绍如何执行下列操作:In this tutorial, you learn how to:

  • 将新版本添加到现有 APIAdd a new version to an existing API
  • 选择版本方案Choose a version scheme
  • 将版本添加到产品Add the version to a product
  • 浏览开发人员门户以查看版本Browse the developer portal to see the version

转到下一教程:Advance to the next tutorial: