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

通过适用于 Visual Studio Code 的 Azure API 中心扩展生成并注册 API

2025-05-30

组织中的 API 生成者开发人员可以使用 Visual Studio Code 的 Azure API 中心扩展在 API 中心清单中生成和注册 API。 API 开发人员可以：

通过一次性的操作将现有 API 添加到 API 中心，或者集成开发管道以将 API 注册为 CI/CD 工作流的一部分。
使用 GitHub Copilot 从 API 代码生成新的 OpenAPI 规范。

API 生成者开发人员还可以利用扩展中的功能在 API 中心发现和使用 API，并确保实现 API 治理。

先决条件

Visual Studio Code
适用于 Visual Studio Code 的 Azure API 中心扩展
Azure 订阅中的一个或多个 API 中心。可以使用 Azure API 中心扩展或其他工具创建 API 中心。
- 目前，需要拥有 API 中心的 Azure API 中心服务参与者角色或更高权限才能使用扩展管理 API。

指定的方案需要以下 Visual Studio Code 扩展：

GitHub Actions - 使用 CI/CD 管道通过 GitHub Actions 注册 API
Azure Pipelines - 使用 CI/CD 管道通过 Azure Pipelines 注册 API
GitHub Copilot - 从 API 代码生成 OpenAPI 规范文件

扩展设置

通过 Visual Studio Code 市场安装适用于 Visual Studio Code 的 Azure API 中心扩展。根据需要安装其他扩展。

注意

值得注意的是，某些功能仅在 Azure API 中心扩展的预发布版本中可用。从 Visual Studio Code Marketplace 安装扩展时，可以选择安装发布版本或预发布版本。可以使用“扩展”视图中扩展的“管理”按钮上下文菜单随时在两个版本之间进行切换。
在 Visual Studio Code 的左侧“活动栏”中，选择“API 中心”。
如果尚未登录 Azure 帐户，请选择“登录到 Azure...”，然后按照提示完成登录。选择一个 Azure 订阅，其中需包含你要用于查看 API 的 API 中心。如果你有很多可供查看的订阅，你还可以筛选特定订阅。

注册 API - 分步说明

以下步骤通过一次性的操作在 API 中心注册 API。

使用键盘快捷方式 (Ctrl+Shift+P) 开启命令面板。输入 Azure API Center: Register API，然后按“Enter”。
选择“手动”。
选择要将 API 注册到的 API 中心。
回答提示中请求的信息，包括 API 标题、类型、版本标题、版本生命周期、定义标题、规范名称和定义文件，以完成 API 注册。

该 API 将添加到 API 中心清单中。

注册 API - CI/CD 管道

以下步骤使用 CI/CD 管道在 API 中心注册 API。此选项会将预配置的 GitHub 或 Azure DevOps 管道添加到活动的 Visual Studio Code 工作区，该工作区在每次提交到源代码管理时作为 CI/CD 工作流的一部分运行。建议使用 CI/CD 在 API 中心清点 API，以确保 API 元数据（包括规范和版本）在 API 中心保持最新状态，因为 API 会随着时间推移而不断发展。

使用键盘快捷方式 (Ctrl+Shift+P) 开启命令面板。输入 Azure API Center: Register API，然后按“Enter”。
选择 CI/CD。
选择“GitHub”或“Azure DevOps”，具体取决于首选的源代码管理机制。必须为 Azure API 中心扩展打开 Visual Studio Code 工作区，这样才能将管道添加到工作区。添加文件后，完成 CI/CD 管道文件本身中记录的步骤以配置所需的环境变量和标识。在推送到源代码管理时，系统会将 API 注册到 API 中心。

详细了解如何设置 GitHub Actions 工作流以向 API 中心注册 API。

从 API 代码生成 OpenAPI 规范

使用 GitHub Copilot 的强大功能和适用于 Visual Studio Code 的 Azure API Center 扩展，从 API 代码创建 OpenAPI 规范文件。右键单击 API 代码，从选项中选择“Copilot”，然后选择“生成 API 文档”。 GitHub Copilot 会创建 OpenAPI 规范文件。

还可以从当前项目中的所有文件生成 OpenAPI 规范。使用命令面板中的Azure API Center: Generate OpenAPI Spec from Entire Project命令来生成整个项目的 OpenAPI 规范。

生成 OpenAPI 规范文件并检查准确性后，可以使用“Azure API 中心: 注册 API”命令将该 API 注册到 API 中心。

提示

API 开发人员还可使用适用于 Azure 的 GitHub Copilot API 中心插件，通过自然语言提示生成新的 OpenAPI 规范。了解详细信息。