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

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

本页面介绍了如何在 Cloud Code for VS Code 中创建 Apigee API Management 本地开发环境。如需了解本地开发环境中的功能，请参阅使用 Apigee 进行本地开发的概览。

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

根据您的使用情形，还需完成为 Apigee 本地开发设置 API 代理开发

准备工作

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

  1. 用于在本地开发环境中登录的 Google Cloud 项目。需要为项目预配 Apigee，才能创建 Apigee 本地工作区，您可以在其中开发和测试 API 代理。
  2. （推荐）在您的项目上预配的 API Hub。创建 远程模拟服务器以测试 API 规范时，需要使用 API Hub。

    如果您不想将 API Hub 添加到项目中，可以改为将该项目与启用了 API Hub 的另一个项目相关联。如需了解如何将项目关联到 API Hub，请参阅 将运行时项目关联到 API Hub。
  3. 在 Apigee 本地开发中使用 API Hub 所需的角色，以用于您想要执行的操作。
  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 代理，请在该过程中安装 Docker。
  3. （推荐）为 Cloud Code 扩展程序启用自动更新。在设置中，搜索扩展程序：自动更新，然后为所有扩展程序或单独为 Cloud Code 扩展程序启用该设置。
  4. 重启 VS Code。

将 Apigee API Hub 与 Apigee 本地开发搭配使用所需具备的角色

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

任务 所需的角色
查看和修改 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：