共用方式為

教學課程：在您的 API 清查中註冊 API

  • 發行項

在本教學課程中，藉由使用 Azure 入口網站 註冊 API 並指派元數據，以在組織的 API 中心啟動 API 清查。

如需您可以在 Azure API 中心清查之 API、API 版本、定義和其他實體的背景資訊，請參閱 重要概念。

在本教學課程中，您會了解如何使用入口網站執行下列動作：

  • 註冊一或多個 API
  • 新增 API 版本與 API 定義

必要條件

註冊 API

當您在 API 中心註冊 （新增） API 時，API 註冊包括：

  • 標題 (名稱)、類型和描述
  • 版本資訊
  • 選擇性地包含文件和連絡人的連結
  • 您定義的內建和自訂元數據

註冊 API 之後，您可以將版本和定義新增至 API。

下列步驟會註冊兩個範例 API：Swagger Petstore API 和會議 API（請參閱 必要條件）。 如果您想要的話，請註冊您自己的 API。

  1. 在入口網站中，瀏覽至您的 API 中心。

  2. 在左側功能表中的 [資產] 底下，選取 [API>+ 註冊 API]。

  3. 在 [ 註冊 API] 頁面中，新增 Swagger Petstore API 的下列資訊。 您會在頁面底部的上一個教學課程中看到您在上一個教學課程中定義的自定義 企業 營運和 公開對應 元數據。

    設定 值 Description
    API 標題 輸入 Swagger Petstore API。 您為 API 選擇的名稱。
    識別 輸入上述標題之後，Azure API 中心會產生此標識碼，您可以加以覆寫。 API 的 Azure 資源名稱。
    API 類型 從下拉式清單中選取 [REST]。 API 的類型。
    摘要 選擇性地輸入摘要。 API 的摘要描述。
    說明 選擇性地輸入描述。 API 的描述。
    版本
    版本標題 輸入您選擇的版本標題，例如 v1。 您為 API 版本選擇的名稱。
    版本識別 輸入上述標題之後，Azure API 中心會產生此標識碼，您可以加以覆寫。 版本的 Azure 資源名稱。
    版本生命週期 從下拉式清單中進行選取，例如 [測試] 或 [生產]。 API 版本的生命週期階段。
    外部文件 選擇性地將一或多個連結新增至外部文件。 API 文件的名稱、描述和 URL。
    授權 選擇性地新增授權資訊。 API 授權的名稱、URL 和標識碼。
    連絡人資訊 選擇性地新增一或多位連絡人的資訊。 API 連絡人的名稱、電子郵件和 URL。
    企業營運 如果您在上一個教學課程中新增此元數據，請從下拉式清單中選取專案，例如 Marketing。 識別擁有 API 之業務單位的自定義元數據。
    公開 如果您新增此元數據，請選取複選框。 識別 API 是公開或僅限內部的自定義元數據。

    在入口網站中註冊 API 的螢幕快照。

  4. 選取 建立。 API 已註冊。

  5. 重複上述三個步驟來註冊另一個 API，例如會議 API。

提示

當您在入口網站中註冊 API 時，您可以選取任何預先定義的 API 類型，或輸入您選擇的另一種類型。

API 會出現在入口網站中的 [API] 頁面上。 當您將大量 API 新增至 API 中心時，請使用此頁面上的搜尋方塊和篩選來尋找您想要的 API。

入口網站中 API 頁面的螢幕快照。

註冊 API 之後，您可以檢視或編輯 API 的屬性。 在 [ API] 頁面上，選取 API 以查看管理 API 註冊的頁面。

新增 API 版本

在整個生命週期中，API 可能會有多個版本。 您可以在 API 中心將版本新增至現有的 API，選擇性地使用定義檔案。

在這裡，您會將版本新增至其中一個 API：

  1. 在入口網站中，瀏覽至您的 API 中心。

  2. 在左側功能表中，選取 [API]，然後選取 API，例如 Swagger Petstore。

  3. 在 [API] 頁面的 [詳細數據] 底下，選取 [版本>+ 新增版本]。

    在入口網站中新增 API 版本的螢幕快照。

  4. 在 [新增 API 版本] 頁面上：

    1. 輸入或選取下列資訊：

      設定 值 Description
      版本標題 輸入您選擇的版本標題，例如 v2。 您為 API 版本選擇的名稱。
      版本識別 輸入上述標題之後，Azure API 中心會產生此標識碼，您可以加以覆寫。 版本的 Azure 資源名稱。
      版本生命週期 從下拉式清單中進行選取，例如 [生產]。 API 版本的生命週期階段。

    2. 選取 建立。 已新增版本。

將定義新增至您的版本

您通常會想要將 API 定義新增至 API 版本。 Azure API 中心支援通用文字規格格式的定義，例如 OpenAPI 2 和 3 for REST API。

若要將 API 定義新增至您的版本：

  1. 在 API 的 [ 版本] 頁面上，選取您的 API 版本。

  2. 在 API 版本的左側選單中，於 [詳細數據] 底下，選取 [定義>+ 新增定義]。

  3. 在 [新增定義] 頁面上：

    1. 輸入或選取下列資訊：

      設定 值 Description
      職稱 輸入您選擇的標題，例如 v2 定義。 您為 API 定義選擇的名稱。
      識別 輸入上述標題之後，Azure API 中心會產生此標識碼，您可以加以覆寫。 定義的 Azure 資源名稱。
      說明 選擇性地輸入描述。 API 定義的描述。
      規格名稱 針對 [寵物存放區 API]，選取 [ OpenAPI]。 API 的規格格式。
      規格版本 輸入您選擇的版本識別碼，例如 3.0。 規格版本。
      Document 流覽至 Petstore API 的本機定義檔案，或輸入 URL。 範例 URL： https://raw.githubusercontent.com/swagger-api/swagger-petstore/refs/heads/master/src/main/resources/openapi.yaml API 定義檔案。

      在入口網站中新增 API 定義的螢幕快照。

    2. 選取 建立。 已新增定義。

在本教學課程中，您已了解如何使用入口網站來執行下列動作：

  • 註冊一或多個 API
  • 新增 API 版本與 API 定義

當您建置 API 清查時，請利用自動化工具來註冊 API，例如 適用於 Visual Studio Code 的 Azure API 中心延伸模組和 Azure CLI。

下一步

您的 API 清查開始成形！ 現在您可以新增 API 環境和部署的相關資訊。

新增 API 環境和部署