在 Cloud Code for VS Code 中設定 Apigee API 管理平台

本頁內容適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

本頁說明如何在 Cloud Code for VS Code 中，建立 Apigee API 管理平台本機開發環境。如要瞭解本機開發環境中的功能，請參閱「 透過 Apigee 本機開發的總覽」。

設定程序需要完成本指南的這兩個部分：

視您的用途而定，請一併完成「為 Apigee 本機開發設定 API Proxy 開發作業」。

事前準備

如要在 VS Code 中設定及使用 Apigee，您需要：

  1. Google Cloud 要在本機開發環境登入的專案。專案必須佈建 Apigee，才能建立 Apigee 本機工作區，供您開發及測試 API Proxy。
  2. (建議) 在專案中佈建 Apigee API 中心。整合 API 中心後，您就能在 Cloud Code 中存取及編輯生態系統的 API。如要建立 遠端模擬伺服器來測試 API 規格，也必須使用 API 中心。

    如果不想將 API 中心新增至專案，可以改為將專案與已啟用 API 中心的其他專案建立關聯。如要瞭解如何將專案附加至 API 中心，請參閱「 將執行階段專案附加至 API 中心」。

    請參閱「使用 Apigee 本機開發環境時，使用 API 中心所需的角色」，瞭解您打算執行的動作。
  3. 熟悉 VS Code、瞭解如何管理 VS Code，以及如何執行常見動作，例如存取設定和安裝擴充功能。請參閱 VS Code 說明文件。

使用 Apigee 本機開發功能時，透過 Apigee API 中心所需的角色

如要使用 Apigee API 中心 API 執行 API 設計和測試步驟，您需要下列角色：

工作 必要角色
查看及編輯 API 中心 API Cloud API Hub 管理員或 Cloud API Hub 編輯者
將 API 發布至 API 中心 Cloud API Hub 管理員或 Cloud API Hub 編輯者
設定及管理 遠端模擬伺服器，測試 API Artifact Registry 管理員
Cloud Build 服務帳戶
Cloud Run 管理員
服務使用情形管理員

請參閱 Identity and Access Management (IAM) 基本和預先定義的角色參考資料。

您也必須安裝 Google Cloud CLI。

安裝 VS Code 和 Cloud Code 擴充功能

本節提供安裝 VS Code 和 VS Code 中 Cloud Code 擴充功能的安裝說明。這是設定 Apigee 本機開發環境的第一步，也是使用任何 Apigee 本機開發功能的前提

如要安裝 VS Code 和 Cloud Code 擴充功能，請按照下列步驟操作：

  1. 如果尚未安裝，請在本機電腦下載並安裝 Visual Studio Code (VS Code)。
  2. 按照「 安裝 Cloud Code 擴充功能」一文的說明安裝 Cloud Code 擴充功能。如果您打算在本機環境中管理 API 代理項目，請在安裝過程中安裝 Docker。
  3. (建議) 啟用 Cloud Code 擴充功能的自動更新功能。在「設定」中搜尋「Extensions: Auto Update」，然後為所有擴充功能或個別為 Cloud Code 擴充功能啟用這項設定。
  4. 重新啟動 VS Code。

為 Apigee 本機開發作業設定 API Proxy 開發環境

如要在本機開發環境中開發及測試 Apigee API Proxy，請完成本節中的步驟。此外，如要從 OpenAPI 規格建立 API Proxy，也請完成這些步驟。

  1. 建立 Apigee 工作區。
  2. 安裝 Apigee Emulator。
  3. 新增容器，以便部署至 Apigee 模擬器。

後續步驟

完成安裝和設定步驟後，即可開始使用 Cloud Code：