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

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

查看 Apigee Edge 說明文件。

本頁說明如何在 Cloud Code for VS Code 中建立 Apigee API 管理本機開發環境，這項工具支援 Gemini Code Assist，可協助您設計及開發 OpenAPI 規格。如要瞭解本機開發環境中的功能，請參閱「 透過 Apigee 本機開發的總覽」。

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

視用途而定，請完成下列一或兩個章節：

事前準備

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

  1. 本機開發環境中要登入的 Google Cloud 專案。如要使用 Gemini Code Assist 開發 API 規格，專案不需要佈建 Apigee，但如要建立 Apigee 本機工作區來開發及測試 API Proxy，則必須佈建 Apigee。您也必須佈建 Apigee，才能在 Cloud Code 的 Apigee 專區中看到任何 Apigee API 中心 API。
  2. (建議) 在專案中佈建 API 中心。如要使用下列功能，必須啟用 API 中心： 如果不想將 API 中樞新增至專案，可以改為將專案與已啟用 API 中樞的其他專案建立關聯。如要瞭解如何將專案附加至 API 中心，請參閱「 將執行階段專案附加至 API 中心」。
  3. 如要執行特定動作，請參閱這篇文章，瞭解在 Apigee 中使用 Gemini Code Assist 時需要哪些角色。如要為專案設定 Gemini Code Assist，您必須具備使用者帳戶的服務用量管理員角色。
  4. 熟悉 VS Code、如何管理 VS Code，以及如何執行常見動作，例如存取設定和安裝擴充功能。請參閱 VS Code 說明文件。

安裝 VS Code 和 Cloud Code 擴充功能

本節提供安裝 VS Code 和 VS Code 中 Cloud Code 擴充功能的說明。這是設定 Apigee 本機開發環境的第一步，也是使用任何 Apigee 本機開發功能 (包括 Gemini Code Assist) 的必要條件。

如要安裝 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 設定 Gemini Code Assist

請按照下列步驟，在本機開發環境中設定 Apigee 專用的 Gemini Code Assist。請注意， 在 Apigee 中使用 Gemini Code Assist 的必要角色。

  1. 請確認您已完成「 安裝 VS Code 和 Cloud Code 擴充功能」中的步驟 (如尚未完成)。
  2. 在 VS Code 中安裝 Gemini Code Assist 擴充功能。
  3. (建議) 啟用 Gemini Code Assist 擴充功能的自動更新功能。在「Settings」中搜尋「Extensions: Auto Update」，然後為所有擴充功能或個別為 Gemini Code Assist 擴充功能啟用這項功能。
  4. 如果尚未安裝，請安裝 gcloud CLI。
  5. 為專案啟用 Gemini for Google Cloud API。您必須具備「服務使用管理員」角色，才能執行這個步驟。
    gcloud services enable cloudaicompanion.googleapis.com --project=YOUR_PROJECT
  6. 在 VS Code 中，同時登入 Gemini Code Assist 和 Cloud Code 擴充功能的 Google Cloud 專案。你可以使用下列任一方法：
    • 在 settings.json 檔案中手動新增專案： 
      {
  "cloudcode.apigee.gemini.options": {
      "cloudcode.project": "YOUR_PROJECT",
      "geminicodeassist.project": "YOUR_PROJECT"
    ...
    }
  }
    • 系統提示時選取專案：

      開啟 Gemini Code Assist 對話時，如果尚未登入已啟用 Gemini 的專案，系統會顯示相關訊息，並提供登入方式。 選取「選取 Google Cloud 專案」，新增專案。
      Gemini Code Assist Chat 缺少專案

      如要在 Cloud Code 的 Apigee 區段中選取專案，請展開「API hub」 Google Cloud 區段，然後點選「Cloud Code - No Project selected」：
      Google Cloud 無專案

      或者，點選 Cloud Code 狀態列中的專案名稱，然後選取新專案： Cloud Code 狀態列顯示 Apigee 專案
  7. 將 在 Apigee 中使用 Gemini Code Assist 的必要角色新增至使用者帳戶。
  8. 如要從 OpenAPI 規格建立 API Proxy 套件，並在本機開發環境中管理，請完成「設定本機 API Proxy 開發環境」一文中的步驟。

在 Apigee 中使用 Gemini Code Assist 的必要角色

如要使用 Gemini Code Assist 執行 API 設計和測試步驟，您需要下列角色：

工作 必要角色
使用 Gemini Code Assist 設計 API Gemini for Google Cloud 使用者
服務使用情形消費者

請參閱 在 Google Cloud 專案中授予 Gemini Code Assist 的 IAM 角色。
在 設計 API 時，使用 API 中心現有 API 的企業情境 Cloud API Hub 檢視者
編輯 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：