在 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. (建議) 在專案中佈建 API 中心。如要建立 遠端模擬伺服器來測試 API 規格，必須使用 API 中心。

    如果不想將 API 中心新增至專案，可以改為將專案與已啟用 API 中心的其他專案建立關聯。如要瞭解如何將專案附加至 API 中心，請參閱「 將執行階段專案附加至 API 中心」。
  3. 如要瞭解您打算執行的動作，使用 Apigee 本機開發環境的 API 中心時需要哪些角色。
  4. 熟悉 VS Code、如何管理 VS Code，以及如何執行常見動作，例如存取設定和安裝擴充功能。請參閱 VS Code 說明文件。

安裝 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 Proxy，請在程序中安裝 Docker。
  3. (建議) 啟用 Cloud Code 擴充功能的自動更新功能。在「設定」中搜尋「Extensions: Auto Update」，然後為所有擴充功能或個別為 Cloud Code 擴充功能啟用這項設定。
  4. 重新啟動 VS Code。

使用 Apigee 本機開發功能時，必須具備的 Apigee API 中心角色

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

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

請參閱 IAM 基本和預先定義角色參考資料。

您也必須安裝 gcloud CLI。

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

如要使用本機開發環境開發及測試 Apigee API Proxy，請完成本節中的步驟。此外，請完成下列步驟，才能從 OpenAPI 規格建立 API Proxy。

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

後續步驟

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