貴組織中的 API 生產商開發人員可以使用適用於 Visual Studio Code 的 Azure API 中心延伸模組在您的 API 中心詳細目錄中建置和註冊 API。 API 開發人員可以:
- 以一次性作業的方式將現有的 API 新增至 API 中心,或整合開發管線以將 API 註冊為 CI/CD 工作流程的一部分。
- 使用 GitHub Copilot 從 API 程式碼產生新的 OpenAPI 規格。
API 取用者開發人員也可以利用延伸模組中的功能,在 API 中心探索及取用 API,並確保 API 控管。
先決條件
Azure 訂用帳戶中的一或多個 API 中心。 您可以使用 Azure API 中心擴充功能或其他工具來建立 API 中心 。
- 目前,您必須獲派 API 中心上的 Azure API 中心服務參與者角色或更高權限,才能使用延伸模組管理 API。
指定的案例需要下列 Visual Studio Code 延伸模組:
- GitHub Actions,使用 CI/CD 管線向 GitHub Actions 註冊 API
- Azure Pipelines,使用 CI/CD 管線向 Azure Pipelines 註冊 API
- GitHub Copilot,從 API 程式碼產生 OpenAPI 規格檔案
延伸模組設定
從 Visual Studio Code Marketplace 安裝適用於 Visual Studio Code 的 Azure API 中心延伸模組。 視需要安裝其他延伸模組。
附註
值得注意的是,某些功能僅在 Azure API 中心延伸模組的發行前版本中提供。 從 Visual Studio Code Marketplace安裝延伸模組時,您可以選擇安裝發行版本或發行前版本。 使用延伸模組檢視中延伸模組的 [管理] 按鈕操作功能表,隨時切換兩個版本。
在 Visual Studio Code 左側的 [活動列] 中,選取 [API 中心]。
如果您未登入 Azure 帳戶,請選取 [登入 Azure...],並依照提示登入。 選取具有您希望從中檢視 API 的 API 中心 (或多個 API 中心) 的 Azure 訂用帳戶。 如果有許多要檢視的訂用帳戶,您也可以篩選特定訂用帳戶。
手動註冊 API
下列步驟是在您的 API 中心註冊 API 的一次性作業。
- 使用 Ctrl+Shift+P 鍵盤快速鍵開啟命令選擇區。 輸入 Azure API Center: Register API,然後點擊 Enter。
- 選取 [手動]。
- 選取要註冊 API 的 API 中心。
- 回答提示,其中包含 API 標題、類型、版本標題、版本生命週期、定義標題、規格名稱和定義檔案的資訊,以完成 API 註冊。
API 會新增至您的 API 中心詳細目錄。
使用 CI/CD 管線註冊 API
下列步驟會透過 CI/CD 管線在您的 API 中心註冊 API。 透過此選項,在您使用中的 Visual Studio Code 工作區中新增預先設定的 GitHub 或 Azure DevOps 管線,此管線會在每次認可至原始檔控制時,作為 CI/CD 工作流程的一部分執行。 隨著 API 不斷演進,建議您使用 CI/CD 清查 API 中心內的 API,以確保 API 中繼資料 (包括規格和版本) 在 API 中心始終保持最新狀態。
- 使用 Ctrl+Shift+P 鍵盤快速鍵開啟命令選擇區。 輸入 Azure API Center: Register API,然後點擊 Enter。
- 選取 [CI/CD]。
- 根據您慣用的原始檔控制機制,選取 GitHub 或 Azure DevOps。 Visual Studio Code 工作區必須開啟,Azure API 中心延伸模組才能將管線新增至工作區。 新增檔案後,請完成 CI/CD 管線檔案本身中所記錄的步驟,以設定所需環境變數和身分識別。 在推送至原始檔控制時,在 API 中心註冊 API。
若要深入了解如何設定 GitHub Actions 工作流程,請參閱使用 GitHub Actions 在 API 中心註冊 API (部分機器翻譯)。
從 API 程式碼產生 OpenAPI 規格
使用 GitHub Copilot 的強大功能並搭配適用於 Visual Studio Code 的 Azure API 中心延伸模組,從您的 API 程式碼建立 OpenAPI 規格檔案。 以滑鼠右鍵按一下 API 程式碼,從選項中選取 [Copilot],然後選取 [產生 API 文件]。 GitHub Copilot 可建立 OpenAPI 規格檔案。
您也可以從目前專案中的所有檔案產生 OpenAPI 規格。 使用命令選擇區的 [Azure API 中心:從整個專案產生 OpenAPI 規格] 命令。
產生 OpenAPI 規格檔案並檢查正確性之後,您就可以使用 Azure API Center: Register API 命令向 API 中心註冊 API。
秘訣
API 開發人員也可以使用自然語言提示,並搭配適用於 Azure 的 GitHub Copilot API 中心外掛程式來產生新的 OpenAPI 規格。 若要深入了解,請參閱設計和開發 API。