使用適用於Visual Studio Code的 Azure API 中心擴充功能控管 API
若要將 API 治理工作的成功最大化,請務必儘早將左控管移轉至 API 開發週期。 此方法可讓 API 開發人員從頭開始正確地建立 API,並將它們從浪費的開發工作中節省下來,並降低開發程式中不符合規範的 API。
適用於 Visual Studio Code 的 Azure API 中心延伸模組包含下列 API 開發人員的治理功能:
- 在 Visual Studio Code 中開發 API 時,針對 API 樣式指南評估 API 設計。
- 早期偵測重大變更,讓 API 保持可靠且如預期般運作,以保留終端用戶和項目關係人的信任。
API 開發人員也可以利用延伸模組中的功能,在 API 中心註冊 API ,並 探索及取用 API。
必要條件
Azure 訂用帳戶中的一或多個 API 中心。
- 目前,您必須在 API 中心指派 Azure API 中心服務參與者角色或更高許可權,才能使用擴充功能管理 API。
- Visual Studio Code 的光譜延伸模組 - 在 Visual Studio Code 中執行 Shift-left API 設計一致性檢查
- Optic CLI:偵測 API 規格文件之間的重大變更
設定
從 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 時,適用於 Visual Studio Code 的 Azure API 中心擴充功能提供 API 規格的整合式支援。
- 使用 Ctrl+Shift+P 鍵盤快速鍵開啟命令選擇區。 輸入 Azure API 中心:設定作用中 API 樣式指南,然後按 Enter 鍵。
- 選取其中一個隨附的預設規則,或者,如果您的組織已有可用的樣式指南,請使用 [選取本機檔案] 或 [輸入遠端 URL],在 Visual Studio Code 中指定作用中規則集。 按 Enter 鍵。
在設定作用中 API 樣式指南後,若開啟任何 OpenAPI 或 AsyncAPI 型規格檔案,都會在 Visual Studio Code 中觸發本機 Lint 分析作業。 結果會顯示在編輯器和 [問題] 視窗中內嵌顯示(檢視>問題或 Ctrl+Shift+M)。
重大變更偵測
推出新版本的 API 時,請務必確保所做的變更不會導致使用舊版 API 的取用者發生功能中斷的問題。 適用於 Visual Studio Code 的 Azure API 中心延伸模組可讓您輕鬆地針對由光學提供的 OpenAPI 規格檔進行重大變更偵測。
- 使用 Ctrl+Shift+P 鍵盤快速鍵開啟命令選擇區。 輸入 Azure API 中心:偵測中斷性變更,然後按 Enter 鍵。
- 選取要比較的第一個 API 規格文件。 有效選項包括位於 API 中心、本機檔案或 Visual Studio Code 作用中編輯器中的 API 規格。
- 選取要比較的第二個 API 規格文件。 有效選項包括位於 API 中心、本機檔案或 Visual Studio Code 作用中編輯器中的 API 規格。
Visual Studio Code 會在兩個 API 規格之間開啟差異檢視。 任何重大變更都會在編輯器和 [問題] 視窗中內嵌顯示(檢視>問題或 Ctrl+Shift+M)。