共用方式為


使用適用於 Azure 的 GitHub Copilot API 中心外掛程式來設計和開發 API

適用於 Azure 的 GitHub Copilot 的 API Center 外掛程式可加速從自然語言提示開始設計和開發新 API。 透過 API 中心外掛程式搭配 API 中心 VS Code 延伸模組提供的 AI 協助,只需描述 API 並快速產生符合您組織標準的 API 開發 OpenAPI 規格。 產生相容的規格之後,您就可以向 API 中心註冊 API。

必要條件

擴充功能設定

  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 訂用帳戶。 如果有許多要檢視的訂用帳戶,您也可以篩選特定訂用帳戶。

向 @azure 代理程式提出要求

請遵循下列步驟,搭配 GitHub Copilot for Azure 使用自然語言提示來產生 OpenAPI 規格:

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

    如果未設定任何樣式指南,則會使用默認 spectral:oas 規則集。 深入瞭解 使用 API 中心擴充功能進行 API 規格 Linting

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

    @azure Generate an 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. Check that there are no duplicate keys.
    

    Copilot 是由 AI 所提供,因此可能會有驚喜和錯誤。 如需詳細資訊,請參閱 Copilot 常見問題。

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

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

  3. 檢閱產生的輸出,以取得 API 樣式指南的正確性、完整性和合規性。

    如果需要重新產生規格,請精簡提示,或使用您在 Azure API 中心擴充功能中設定的不同樣式指南重複此程式。

    提示

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

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

在 API 中心註冊 API

使用適用於 VS Code 的 Azure API 中心擴充功能,從產生的規格檔案,在您的 API 中心註冊 API。 註冊 API 之後,您可以使用擴充功能來檢視 API 檔、產生 HTTP 用戶端、執行進一步的 Linting 和分析等等。

  1. 在 VS Code 中,選取 聊天面板中的 [在 API 中心 註冊 API] 按鈕,或從命令選擇區選取 [Azure API 中心:註冊 API ]。

  2. 選取 [手動]

  3. 選取要註冊 API 的 API 中心。

  4. 回答提示,其中包含 API 標題、類型、版本標題、版本生命週期、定義標題、規格名稱和定義(規格)檔案,以完成 API 註冊。

註冊 API 之後,您可以使用擴充功能來執行各種工作。 例如, 在 Swagger UI 中檢視 API 檔

  1. 展開 [API 中心] 樹檢視,以選取您註冊之 API 版本的定義。

  2. 以滑鼠右鍵按一下定義,並選取 [開啟 API 文件]。 新的索引標籤隨即出現,其中包含 API 定義的 Swagger UI。

VS Code 延伸模組中 Swagger UI 的螢幕快照。