你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
使用 Visual Studio Code 的 Azure API 中心扩展治理 API
为了最大限度地提高 API 治理工作的成功率，必须在 API 开发周期的早期对治理进行左移 (shift-left) 处理。 通过此方法，API 开发人员可以从一开始就正确创建 API 以避免浪费开发精力，并在开发过程的后续阶段减少不符合要求的 API。
Visual Studio Code 的 Azure API 中心扩展包括面向 API 开发人员的以下治理功能：
- 在使用 Visual Studio Code 开发 API 的过程中，根据 API 样式指南评估 API 设计。
- 及早发现中断性变更，从而使 API 保持可靠并按预期运行，以维系最终用户和利益干系人的信任。
API 开发人员还可以利用该扩展中的功能在 API 中心注册 API，然后发现和使用 API。
先决条件
Azure 订阅中的一个或多个 API 中心。
- 目前，需要拥有 API 中心的 Azure API 中心服务参与者角色或更高权限才能使用扩展管理 API。
- Visual Studio Code 的 Spectral 扩展 - 在 Visual Studio Code 中运行左移 API 设计合规性检查
- Optic CLI - 用于检测 API 规范文档之间的中断性变更
安装
通过 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 时的设计符合组织标准，Visual Studio Code 的 Azure API 中心扩展为使用 Spectral 进行 API 规范 Lint 分析提供了集成支持。
- 使用键盘快捷方式 (Ctrl+Shift+P) 开启命令面板。 输入“Azure API 中心：设置活动 API 样式指南”，然后按“Enter”。
- 选择提供的默认规则之一，或者，如果你的组织已有样式指南，请使用“选择本地文件”或“输入远程 URL”，以在 Visual Studio Code 中指定活动规则集。 按“Enter”。
设置了活动的 API 样式指南后，打开任何基于 OpenAPI 或 AsyncAPI 的规范文件会触发 Visual Studio Code 中的本地 Lint 分析操作。 结果会在编辑器中内联显示，并在“问题”窗口中显示（“查看”>“问题”或 Ctrl+Shift+M）。
中断性变更检测
引入新版 API 时，重要的是要确保引入的变更不会破坏旧版 API 上的 API 使用者的体验。 Visual Studio Code 的 Azure API 中心扩展可以对 Optic 所支持的 OpenAPI 规范文档进行中断性变更检测，使这一切变得轻而易举。
- 使用键盘快捷方式 (Ctrl+Shift+P) 开启命令面板。 键入“Azure API 中心: 检测中断性变更”，然后按“Enter”。
- 选择要比较的第一个 API 规范文档。 有效选项包括在 API 中心、本地文件或 Visual Studio Code 的活动编辑器中找到的 API 规范。
- 选择要比较的第二个 API 规范文档。 有效选项包括在 API 中心、本地文件或 Visual Studio Code 的活动编辑器中找到的 API 规范。
Visual Studio Code 会打开两个 API 规范之间的差异视图。 任何中断性变更都会在编辑器中内联显示，并在“问题”窗口中显示（“查看”>“问题”或 Ctrl+Shift+M）。
