你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
适用于 Azure 的 GitHub Copilot 的 API 中心插件可加速从自然语言提示开始的新 API 的设计和开发。 可通过 API 中心插件与用于Visual Studio Code的 API 中心扩展结合使用，获得 AI 帮助。 只需描述 API 并快速生成符合组织标准的 API 开发的 OpenAPI 规范。 生成合规规范后，可以将 API 注册到 API 中心。
先决条件
Azure 订阅中的一个或多个 API 中心。 可以使用 Azure API 中心扩展或其他工具创建 API 中心 。
- 若要使用扩展管理 API，目前需要对 API 中心具有 Azure API 中心服务参与者角色或更高权限。
- 适用于 Azure 的 GitHub Copilot - 使用适用于 Azure 的 GitHub Copilot 的 Azure API 中心插件生成 OpenAPI 规范文件
扩展设置
按照以下步骤设置扩展：
通过 Visual Studio Code 市场安装适用于 Visual Studio Code 的 Azure API 中心扩展。 根据需要安装其他扩展。
注意
[PREVIEW]表示仅在 Azure API 中心扩展的预发行版中提供的功能。 从 Visual Studio Code Marketplace 安装扩展时，可以选择安装发布版本或预发行版（如可用）。 若要在已安装的版本之间进行切换，请在 Visual Studio Code 的“扩展”视图中选择扩展的“管理”按钮（齿轮图标）。在 Visual Studio Code 中的活动栏中，选择 API 中心：
如果未登录到 Azure 帐户，请选择“ 登录到 Azure”，然后按照提示登录。
选择一个具有 API 中心（或多个 API 中心）并包含您要查看的 API 的 Azure 订阅。 如果有多个帐户，可以筛选特定订阅。
向 @azure 代理发出请求
按照以下步骤，通过适用于 Azure 的 GitHub Copilot 使用自然语言提示生成 OpenAPI 规范：
如果需要，在 Azure API 中心扩展中设置有效 API 样式指南。 使用键盘快捷方式 (Ctrl+Shift+P) 开启命令面板。 键入“Azure API 中心：设置 API 样式指南”，进行选择，然后按“Enter”。
如果未设置样式指南，则使用默认的
spectral:oas规则集。 详细了解使用 API 中心扩展的 API 规范 Lint 分析。在聊天面板中，以自然语言的形式向
@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 规范文档进行响应。
查看生成的输出，了解 API 样式指南的准确性、完整性和合规性。
如果需要重新生成规范，请优化提示，或者使用在 Azure API 中心扩展中设置的其他样式指南重复该过程。
提示
有效的提示侧重于 API 的业务要求，而不是实现详细信息。 较短的提示有时比较长的提示效果更好。
当它满足你的要求时，请将生成的 OpenAPI 规范保存到文件中。
在 API 中心注册 API
使用适用于 Visual Studio Code 的 Azure API 中心扩展从生成的规范文件中在 API 中心注册 API。 注册 API 后，可以使用该扩展查看 API 文档、生成 HTTP 客户端、执行进一步的 Lint 分析和普通分析等。
在Visual Studio Code中，在聊天面板中选择在 API 中心注册 API按钮，或从命令面板中选择Azure API 中心：注册 API。
选择“手动”。
选择要在其中注册 API 的 API 中心。
回答提示中请求的信息，包括 API 标题、类型、版本标题、版本生命周期、定义标题、规范名称和定义（规范）文件，以完成 API 注册。
注册 API 后，可以使用扩展执行各种任务。 例如，在 Swagger UI 中查看 API 文档：
展开 API 中心树状视图，选择已注册的 API 版本的定义。
右键单击定义，然后选择“打开 API 文档”。 此时会显示一个新选项卡，其中包含 API 定义的 Swagger UI。