在 Cloud Code for VS Code 中设置 Apigee API Management

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

本页面介绍了如何在 Cloud Code for VS Code 中创建 Apigee API Management 本地开发环境，该环境支持使用 Gemini Code Assist 进行 OpenAPI 规范设计和开发。如需了解本地开发环境中的功能，请参阅使用 Apigee 进行本地开发的概览。

设置过程需要完成本指南的以下两个部分：

您还可以根据自己的应用场景，完成以下一个或两个部分：

准备工作

如需设置和使用 Apigee in VS Code，您需要：

  1. 用于在本地开发环境中登录的 Google Cloud 项目。无需为 Apigee 预配项目，即可使用 Gemini Code Assist 开发 API 规范，但需要为 Apigee 进行预配，才能创建 Apigee 本地工作区，您可以在其中开发和测试 API 代理。您还需要预配 Apigee，才能在 Cloud Code 的 Apigee 部分中看到任何 Apigee API Hub API。
  2. （推荐）在您的项目上预配的 API Hub。以下功能需要 API Hub： 如果您不想将 API Hub 添加到项目中，可以改为将该项目与启用了 API Hub 的另一个项目相关联。如需了解如何将项目关联到 API Hub，请参阅将运行时项目关联到 API Hub。
  3. 在 Apigee 中使用 Gemini Code Assist 所需的角色，以用于您想要执行的操作。您必须具有项目用户账号的 Service Usage Admin 角色，才能设置 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 代理，请在该过程中安装 Docker。
  3. （推荐）为 Cloud Code 扩展程序启用自动更新。在设置中，搜索扩展程序：自动更新，然后为所有扩展程序或单独为 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 扩展程序启用自动更新。在设置中，搜索扩展程序：自动更新，然后为所有扩展程序或单独为 Gemini Code Assist 扩展程序启用该设置。
  4. 安装 gcloud CLI（如果尚未安装）。
  5. 为项目启用 Gemini for Google Cloud API。您需要拥有 Service Usage Admin 角色才能执行此步骤。
    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 对话缺少项目

      如需在 Cloud Code 的 Apigee 部分中为 Google Cloud 选择项目，请展开 API Hub 部分，然后点击 Cloud Code - 未选择项目：
      Google Cloud 无项目

      或者，点击 Cloud Code 状态栏中的项目名称，然后选择新项目： 显示 Apigee 项目的 Cloud Code 状态栏
  7. 向您的用户账号添加在 Apigee 中使用 Gemini Code Assist 所需的所有角色。
  8. 如果您希望能够根据 OpenAPI 规范创建 API 代理软件包并在本地开发环境中对其进行管理，请完成为 API 代理开发设置本地开发环境中的步骤。

在 Apigee 中使用 Gemini Code Assist 所需的角色

您需要拥有下面所列角色才能使用 Gemini Code Assist 执行 API 设计和测试步骤：

任务 所需的角色
使用 Gemini Code Assist 设计 API Gemini for Google Cloud User
Service Usage Consumer

请参阅在 Google Cloud 项目中为 Gemini Code Assist 授予 IAM 角色。
设计 API 时使用 API Hub 中现有 API 的企业上下文 Cloud API Hub Viewer
修改 API Hub API Cloud API Hub Editor 或 Admin
将 API 发布到 API Hub Cloud API Hub Editor 或 Admin
设置和管理远程模拟服务器以测试 API Artifact Registry Administrator
Cloud Build Service Account
Cloud Run Admin
Service Usage Admin

请参阅 IAM 基本角色和预定义角色参考文档。

您还必须安装 gcloud CLI。

为 Apigee 本地开发设置 API 代理开发

如果您想使用本地开发环境进行 Apigee API 代理开发和测试，请完成本部分中的步骤。此外，请完成以下步骤，以便能够根据 OpenAPI 规范创建 API 代理。

  1. 创建 Apigee 工作区。
  2. 安装 Apigee 模拟器。
  3. 添加容器以部署到 Apigee 模拟器。

后续步骤

完成安装和设置步骤后，开始使用 Cloud Code：