共用方式為

使用適用於 Visual Studio Code 的 Azure API 中心擴充功能建置和註冊 API

  • 發行項

組織中的 API 開發人員可以使用適用於 Visual Studio Code 的 Azure API 中心擴充功能，在 API 中心清查中建置和註冊 API。 API 開發人員可以：

  • 將現有的 API 新增至 API 中心作為一次性作業，或整合開發管線以將 API 註冊為 CI/CD 工作流程的一部分。
  • 使用 GitHub Copilot 從 API 程式代碼產生新的 OpenAPI 規格。
  • 使用自然語言提示搭配 GitHub Copilot for Azure 的 API 中心外掛程式來建立新的 OpenAPI 規格。

API 開發人員也可以利用延伸模組中的功能，在 API 中心探索及取用 API ，並確保 API 控管。

必要條件

指定的案例需要下列 Visual Studio Code 延伸模組：

設定

  1. 從 Visual Studio Code Marketplace 安裝適用於 Visual Studio Code 的 Azure API 中心延伸模組。 視需要安裝其他擴充功能。

    注意

    如前所指出，某些功能僅適用於 Azure API 中心延伸模組的發行前版本。 從 Visual Studio Code Marketplace安裝延伸模組時，您可以選擇安裝發行版本或發行前版本。 使用延伸模組檢視中延伸模組的 [管理] 按鈕操作功能表，隨時切換兩個版本。

  2. 在 Visual Studio Code 左側的 [活動列] 中，選取 [API 中心]。

    活動列中 API 中心延伸模組的螢幕快照。

  3. 如果您未登入 Azure 帳戶，請選取 [登入 Azure...]，並依照提示登入。 使用您想要檢視 API 的 API 中心（或 API 中心）選取 Azure 訂用帳戶。 如果有許多要檢視的訂用帳戶，您也可以篩選特定訂用帳戶。

註冊 API - 逐步執行

下列步驟會將 API 中心中的 API 註冊為一次性作業。

  1. 使用 Ctrl+Shift+P 鍵盤快速鍵開啟命令選擇區。 輸入 Azure API Center: Register API，然後點擊 Enter。
  2. 選取 [手動]。
  3. 選取要註冊 API 的 API 中心。
  4. 回答提示，其中包含 API 標題、類型、版本標題、版本生命週期、定義標題、規格名稱和定義檔案，以完成 API 註冊。

API 會新增至您的 API 中心清查。

註冊 API - CI/CD 管線

下列步驟會在 API 中心向 CI/CD 管線註冊 API。 使用此選項，將預先設定的 GitHub 或 Azure DevOps 管線新增至作用中的 Visual Studio Code 工作區，該工作區會在每次認可原始檔控制時，作為 CI/CD 工作流程的一部分執行。 隨著 API 不斷演進，建議您使用 CI/CD 清查 API 中心內的 API，以確保 API 中繼資料 (包括規格和版本) 在 API 中心始終保持最新狀態。

  1. 使用 Ctrl+Shift+P 鍵盤快速鍵開啟命令選擇區。 輸入 Azure API Center: Register API，然後點擊 Enter。
  2. 選取 [CI/CD]。
  3. 根據您慣用的原始檔控制機制，選取 GitHub 或 Azure DevOps。 Visual Studio Code 工作區必須開啟，Azure API 中心延伸模組才能將管線新增至工作區。 新增檔案之後，請完成 CI/CD 管線檔案本身中所述的步驟，以設定必要的環境變數和身分識別。 在推送至原始檔控制時，API 會在您的 API 中心註冊。

深入瞭解如何設定 GitHub Actions 工作流程 ，以向 API 中心註冊 API。

從 API 程式代碼產生 OpenAPI 規格

使用 GitHub Copilot 與適用於 Visual Studio Code 的 Azure API 中心擴充功能，從 API 程式代碼建立 OpenAPI 規格檔案。 以滑鼠右鍵按一下 API 程式碼，從選項中選取 [Copilot]，然後選取 [產生 API 文件]。 GitHub Copilot 會建立OpenAPI規格檔案。

注意

此功能適用於 API 中心延伸模組的發行前版本。

動畫：示範如何使用 GitHub Copilot，從程式碼產生 OpenAPI 規格。

產生 OpenAPI 規格檔案並檢查正確性之後，您就可以使用 Azure API Center: Register API 命令向 API 中心註冊 API。

使用自然語言提示產生 OpenAPI 規格

適用於 Azure 的 GitHub Copilot API 中心外掛程式（預覽版）可協助您從自然語言提示開始設計新的 API。 透過 AI 協助，快速產生符合您組織標準的 API 開發 OpenAPI 規格。

注意

此功能適用於 API 中心延伸模組的發行前版本。

  1. 如有需要，請設定使用中的 API 樣式指南。 使用 Ctrl+Shift+P 鍵盤快速鍵開啟命令選擇區。 輸入 Azure API 中心：設定 API 樣式指南、進行選取，然後按 Enter。

    如果未設定任何樣式指南，則會使用默認 spectral:oas 規則集。

  2. 在聊天面板中，以自然語言向 @azure 代理程式提出要求，以描述 API 的用途。 範例：

    @azure Generate OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards.

    代理程式會以 OpenAPI 規格檔回應。

    顯示如何使用@azure擴充功能從提示產生 OpenAPI 規格的螢幕快照。

  3. 檢閱產生的輸出，以取得 API 樣式指南的正確性和合規性。 如果需要重新產生，請精簡提示。

    提示

    有效的提示著重於 API 的商務需求，而不是實作詳細數據。 較短的提示有時會比較長的提示效果更好。

  4. 當它符合您的需求時，請將產生的 OpenAPI 規格儲存至檔案。

  5. 向 API 中心註冊 API。 在 聊天面板中選取 [在 API 中心 註冊 API] 按鈕，或從 [命令選擇區] 選取 [註冊 API ]，然後遵循提示。

相關內容