為您的 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 清單中選取 [Demo Conference API]。Select Demo Conference API from the API list.
  2. 選取它旁邊的操作功能表 (...)。Select the context menu (...) next to it.
  3. 選取 [+ 新增版本]。Select + Add Version.

提示

當您第一次建立新的 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.

    注意

    版本實際上是以 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.

    提示

    如果您選取 [標題] 或 [查詢字串] 作為版本設定配置,您需要提供其他值 - 標題名稱或查詢字串參數。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 - 原始v1Underneath Demo Conference API in the API List, you now see two distinct APIs - Original, and v1.

    在 Azure 入口網站中 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,則不會建立「原始」。If you create a new API with versions enabled at the start, an Original is not created.

  6. 您現在可以編輯 v1,並將其設定為與原始不同的 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 路徑,包含 v1It 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: