通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

使用适用于 Azure 的 GitHub Copilot API 中心插件来设计和开发 API

  • 项目

适用于 Azure 的 GitHub Copilot（预览版）的 API 中心插件可让你更快地从自然语言提示开始设计和开发新的 API。 在 API 中心插件和 API 中心 VS Code 扩展提供的 AI 帮助下，只需描述 API 并快速生成符合组织标准的 API 开发的 OpenAPI 规范即可。 生成合规规范后，可以将 API 注册到 API 中心。

注意

该功能在 API 中心扩展的预发布版本中可用。

先决条件

扩展设置

  1. 通过 Visual Studio Code 市场安装适用于 Visual Studio Code 的 Azure API 中心扩展。 安装必备组件中列出的其他扩展。

    注意

    值得注意的是，某些功能仅在 Azure API 中心扩展的预发布版本中可用。 从 Visual Studio Code Marketplace 安装扩展时，可以选择安装发布版本或预发布版本。 可以使用“扩展”视图中扩展的“管理”按钮上下文菜单随时在两个版本之间进行切换。

  2. 在 Visual Studio Code 的左侧“活动栏”中，选择“API 中心”。

    活动栏中的 API 中心扩展的屏幕截图。

  3. 如果尚未登录 Azure 帐户，请选择“登录到 Azure...”，然后按照提示完成登录。 选择一个 Azure 订阅，其中需包含你要用于查看 API 的 API 中心。 如果你有很多可供查看的订阅，你还可以筛选特定订阅。

向 @azure 代理发出请求

按照以下步骤，通过适用于 Azure 的 GitHub Copilot 使用自然语言提示生成 OpenAPI 规范：

  1. 如果需要，在 Azure API 中心扩展中设置有效 API 样式指南。 使用键盘快捷方式 (Ctrl+Shift+P) 开启命令面板。 键入“Azure API 中心：设置 API 样式指南”，进行选择，然后按“Enter”。

    如果未设置样式指南，则使用默认的 spectral:oas 规则集。 详细了解使用 API 中心扩展的 API 规范 Lint 分析。

  2. 在聊天面板中，以自然语言的形式向 @azure 代理发出请求，以描述 API 的作用。 示例：

    @azure Generate an OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards. Check that there are no duplicate keys.

    Copilot 由 AI 提供支持，因此可能会带来意外和错误。 有关详细信息，请参阅 Copilot 常见问题解答。

    代理使用 OpenAPI 规范文档进行响应。

    显示如何使用 @azure 扩展从提示生成 OpenAPI 规范的屏幕截图。

  3. 查看生成的输出，了解 API 样式指南的准确性、完整性和合规性。

    如果需要重新生成规范，请优化提示，或者使用在 Azure API 中心扩展中设置的其他样式指南重复该过程。

    提示

    有效的提示侧重于 API 的业务要求，而不是实现详细信息。 较短的提示有时比较长的提示效果更好。

  4. 当它满足你的要求时，请将生成的 OpenAPI 规范保存到文件中。

在 API 中心注册 API

使用适用于 VS Code 的 Azure API 中心扩展，根据生成的规范文件在 API 中心注册 API。 注册 API 后，可以使用该扩展查看 API 文档、生成 HTTP 客户端、执行进一步的 Lint 分析和普通分析等。

  1. 在 VS Code 中，在聊天面板中选择“在 API 中心注册 API”按钮，或者从命令面板中选择“Azure API 中心: 注册 API”。

  2. 选择“手动”。

  3. 选择要将 API 注册到的 API 中心。

  4. 回答提示中请求的信息，包括 API 标题、类型、版本标题、版本生命周期、定义标题、规范名称和定义（规范）文件，以完成 API 注册。

注册 API 后，可以使用扩展执行各种任务。 例如，在 Swagger UI 中查看 API 文档：

  1. 展开 API 中心树状视图，选择已注册的 API 版本的定义。

  2. 右键单击定义，然后选择“打开 API 文档”。 此时会显示一个新选项卡，其中包含 API 定义的 Swagger 用户界面。

VS Code 扩展中 Swagger UI 的屏幕截图。

相关内容