教程：使用 Gemini Code Assist 在 Apigee 和 Cloud Code 中设计、开发和测试 API

本页面适用于 Apigee 和 Apigee Hybrid。

概览

本教程将引导您使用 Cloud Code 中的 Gemini Code Assist 设计 API，并根据生成的 API 规范创建 Apigee API 代理。在本教程中，您将使用自然语言提示设计和创建一个 API，以便管理网站的体育相关博文。

准备工作

要完成此教程，您需要：

  • 为您的 Apigee 项目设置的 Cloud AI Companion API，或作为 Apigee Org Admin 以便您可以添加它。如需了解 Gemini Code Assist 设置步骤，请参阅使用 Gemini Code Assist。
  • 成为 Apigee 项目的 Apigee API Admin。
  • 如需在 Cloud Code 中为 Apigee 项目设置本地开发（如果您尚未这样做），请参阅在 Cloud Code for VS Code 中设置 Apigee API Management。
  • 熟悉 OpenAPI 规范，以便查看生成的规范。
  • （可选）为此项目设置的 API Hub。虽然使用本文所述的 Gemini Code Assist 功能并非严格要求，但如果没有 API Hub，您将无法执行所有步骤。

第 1 步：在 Cloud Code 中加载 Apigee

打开 VS Code，然后点击 Cloud Code 图标。您应该会看到您的 Apigee 项目和所有 API。

Cloud Code Gemini Code Assist 左侧菜单

第 2 步：打开创建 API 规范标签页并输入提示

点击 Apigee 行中的魔棒图标，以打开规范创建标签页。

Cloud Code Gemini Code Assist 创建规范魔杖

该标签页会显示可用于启动 API 提示的模板。它们下方提供了一个自由格式提示输入字段。点击博客内容的 API。描述此 API 的自然语言提示会填充到提示输入字段。

Cloud Code Gemini Code Assist 创建规范表单

第 3 步：创建和查看规范

点击创建以根据此提示生成 API 规范。等待规范生成；输出面板会在规范创建时显示步骤。

创建后，向下滚动可查看规范说明、端点和架构。如需查看 OpenAPI 规范代码，请点击查看代码。

Cloud Code Gemini Code Assist 规范端点

第 4 步：修改提示并重新创建规范

返回到提示，并将运动类型添加为数据对象的一部分。

Cloud Code Gemini Code Assist 已修改提示

再次点击创建以重新生成规范。您将在更新的规范中看到运动类型。

请注意，您也可以点击提示输入框顶部的提示历史记录来返回上一个提示。

第 5 步：修改规范

您可以点击查看代码并直接在规范中输入更新来更改规范。在此示例中，请将说明更改为“体育博文内容管理 API”。

Cloud Code Gemini Code Assist 修改后的代码

第 6 步：使用模拟服务器测试 API

使用本地模拟服务器测试 API，该服务器会模拟 API 的响应。在服务器下拉列表中，选择名称中包含本地开发服务器的选项。选择后，打开 POST 路径，然后点击尝试。

修改请求正文中的值“author”“content”和“title”，以使用您自己的值：

{
    "author": "My name",
    "categories": [
      "string"
    ],
    "content": "This is my blog post",
    "featuredImageUrl": "string",
    "publishedDate": "string",
    "tags": [
      "string"
    ],
    "title": "Baseball in the age of AI"
  }

点击执行以在回答部分中查看 API 的模拟回答。

第 7 步：将 API 保存到 API Hub

（可选）审核和确定您的 API 后，请通过向 API Hub 注册该 API，将其提供给开发者：

  1. 点击注册到 API Hub。
  2. 按照提示注册 API。如需了解如何向 API Hub 注册以及您需要提供的信息，请参阅注册 API。

点击保存，使用您选择的名称保存新 API。

第 8 步：根据此规范创建 API 代理软件包

要根据此规范创建 Apigee API 代理包，请点击更多菜单中的创建 API 代理包。创建后，您应该在左侧菜单中的 apiproxies 下看到新代理。如需了解如何在 Cloud Code 中使用 API 代理，请参阅开发 API 代理。
Cloud Code Gemini Code Assist 创建 API 代理软件包

后续步骤