启用和查看 Azure API 中心门户视图 - VS Code 扩展

本文介绍如何在适用于 Azure API 中心的 Visual Studio Code 扩展中为企业开发人员提供对 Azure API 中心门户视图的访问权限。 使用门户视图，开发人员可以在 Azure API 中心发现 API、查看 API 定义，并在他们无权管理 API 中心本身或将 API 添加到清单时（可选）生成 API 客户端。 使用 Microsoft Entra ID 和 Azure 基于角色的访问控制来管理对 API 中心门户视图的访问。

先决条件

面向 API 中心管理员

• Azure 订阅中的 API 中心。 如果尚未创建 API 中心，请参阅快速入门：创建 API 中心。

• 在与 Azure 订阅关联的 Microsoft Entra 租户中创建应用注册的权限，以及授予对 API 中心内数据的访问权限的权限。

面向应用开发人员

• 适用于 Visual Studio Code 的 Azure API 中心扩展

  注释

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

以下 Visual Studio Code 扩展是可选的：

• Microsoft Kiota 扩展 - 生成 API 客户端
• GitHub Copilot 和 GitHub Copilot Chat，提供对 GitHub Copilot 的访问权限 - 在代理模式下使用语言模型工具来发现 API

API 中心管理员启用对 API 中心门户视图的访问权限的步骤

以下部分提供了 API 中心管理员的步骤，使企业开发人员能够访问 API 中心门户视图。

创建 Microsoft Entra 应用注册

首先在 Microsoft Entra ID 租户中配置应用注册。 应用注册使 API 中心门户能够代表已登录用户从 API 中心访问数据。

API 中心可以自动设置应用注册，也可以手动创建应用注册。

自动设置应用注册

若要自动设置应用注册，请执行以下步骤：

1. 在 Azure 门户中，导航到 API 中心。
2. 在左侧菜单中，选择 “API 中心门户>设置”。
3. 在“标识提供者”选项卡上，选择“开始设置”。
4. 选择“保存 + 发布”。

手动设置应用注册

若要手动创建应用注册，请执行以下步骤：

1. 在 Azure 门户中，导航到 “Microsoft Entra ID”>“应用注册”。

2. 选择“+ 新建注册”。

3. 在“注册应用程序”页上，将值设置如下：

   1. 将“名称”设置为有意义的名称，例如“api-center-portal”
   2. 在“支持的帐户类型”下，选择“此组织目录中的帐户(单租户)”。
   3. 在“重定向 URI”中，选择“单页应用程序(SPA)”并设置 URI。 使用以下格式输入 API 中心门户部署的 URI：https://<service-name>.portal.<___location>.azure-api-center.ms。 请将 <service name> 和 <___location> 替换为你的 API 中心的名称及其部署的位置，例如：https://myapicenter.portal.eastus.azure-api-center.ms。
   4. 选择“注册”。

为 VS Code 扩展配置其他重定向 URI

在适用于 API 中心的 Visual Studio Code 扩展中启用 API 中心门户视图时，还在应用注册中配置以下重定向 URI：

1. 在 Azure 门户中，导航到应用注册。

2. 在“ 管理>身份验证 ”页上，选择“ 添加平台 ”，然后选择 “移动和桌面应用程序”。

3. 配置以下三个自定义重定向 URI：
   https://vscode.dev/redirect
http://localhost
ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>
   

   将 <application-client-id> 替换为此应用的应用程序（客户端）ID。 可以在应用注册的 “概述 ”页上找到此值。

允许 Microsoft Entra 用户和组登录到 API 中心门户视图

企业开发人员必须使用Microsoft帐户登录，才能查看 API 中心的 API 中心门户视图。 如果需要，请向 Microsoft Entra 租户 添加或邀请开发人员 。

若要启用登录，请将 Azure API 中心数据读取者角色分配给组织中的用户或组，范围限定为 API 中心。

有关向用户和组分配角色的详细先决条件和步骤，请参阅使用 Azure 门户分配 Azure 角色。 简单步骤如下：

1. 在 Azure 门户中，导航到 API 中心。
2. 在左侧菜单中，选择“访问控制(IAM)”“+添加角色分配”。>
3. 在“添加角色分配”窗格中，按如下所示设置值：
   1. 在“角色”页上，搜索并选择 Azure API 中心数据读取者。 选择“下一步”。
   2. 在“成员”页上，在“分配访问权限”中，选择“用户”、“组”或“服务主体”>“+ 选择成员”。
   3. 在“选择成员”页上，搜索并选择要向其分配角色的用户或组。 单击“选择”，然后单击“下一步”。
   4. 查看角色分配，然后选择“查看 + 分配”。

配置对门户的访问权限后，配置的用户可以登录到门户并在 API 中心查看 API。

企业开发人员访问 API 中心门户视图的步骤

开发人员可以按照以下步骤使用 Visual Studio Code 扩展连接并登录到 API 中心门户视图。 连接到 API 中心的设置需要由 API 中心管理员提供。 连接后，开发人员可以在 API 中心发现和使用 API。

连接到 API 中心

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

   

2. 使用键盘快捷方式 (Ctrl+Shift+P) 开启命令面板。 键入 Azure API 中心：连接到 API 中心 并按 Enter。

3. 回答提示以输入以下信息：

   1. API 中心的运行时 URL，格式 <service name>.data.<region>.azure-apicenter.ms （不带 https://前缀）。 示例：contoso-apic.data.eastus.azure-apicenter.ms。 此运行时 URL 显示在 Azure 门户视图中 API 中心的 “概述 ”页上。

   2. 上一部分中管理员配置的应用注册中的应用程序（客户端）ID。

   3. 上一部分中由管理员配置的应用注册中的目录（租户）ID。

   小窍门

   API 中心管理员需要向开发人员提供上述连接详细信息，或提供以下格式的直接链接：
   vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms

   连接到 API 中心后，API 中心的名称将显示在 API 中心门户视图中。

4. 若要查看 API 中心的 API，请在 API 中心名称下选择 “登录到 Azure”。 使用分配了 Azure API 中心数据读取者 角色的 Microsoft 帐户允许登录至 API 中心。

   

5. 登录后，选择 API 以在 API 中心列出 API。 展开 API 以探索其版本和定义。

   

6. 如果配置了访问权限，请重复上述步骤以连接到更多 API 中心。

在 API 中心门户视图中发现和使用 API

API 中心门户视图可帮助企业开发人员发现 API 详细信息并启动 API 客户端开发。 开发人员可以通过在 API 中心门户视图中右键单击 API 定义来访问以下功能：

• 导出 API 规范文档 - 从定义导出 API 规范，然后将其下载为文件
• 生成 API 客户端 - 使用 Microsoft Kiota 扩展为其最喜欢的语言生成 API 客户端
• 生成 Markdown - 以 Markdown 格式生成 API 文档
• OpenAPI 文档 - 查看 API 定义的文档，并尝试在 Swagger UI 中执行作（仅适用于 OpenAPI 定义）

使用语言模型工具

在 Azure API 中心扩展的预发布版本中，有权访问 API 中心门户视图的开发人员可以添加 API 中心语言模型工具，以在 GitHub Copilot 的代理模式下使用。 详细了解如何在代理模式下使用工具。

API 中心工具可用于代理模式，以帮助使用自然语言提示搜索 API 和 API 版本、API 定义和规范、部署等。

若要在 GitHub Copilot 的代理模式下添加和使用 API 中心语言模式工具，

1. 如上一部分所述连接到 API 中心。

2. 在 Visual Studio Code 中打开 GitHub Copilot 聊天。

3. 将 GitHub Copilot Chat 的模式设置为 代理。

4. 在聊天窗口中选择 “工具” 图标。

   

5. 选择要在聊天中使用的一个或多个 API 中心工具。

   

6. 在聊天窗口中输入提示以使用可用工具。 例如：

   Find potential MCP servers for a project I'm working on. I need the deployment URLs from my API center of any MCP servers that can run code snippets.
   

7. 查看 GitHub Copilot Chat 中的响应。 继续对话以优化结果或提出后续问题。

故障排除

无法登录到 Azure

如果在 API 中心门户视图中选择“登录到 Azure”后，已分配了 Azure API 中心数据读取者角色的用户无法完成登录流，则连接配置可能存在问题。

检查在Microsoft Entra ID 中配置的应用注册中的设置。 在应用注册和 API 中心的运行时 URL 中确认应用程序（客户端）ID 和目录（租户）ID 的值。 然后重新建立与 API 中心的连接。

相关内容

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

• Azure RBAC 最佳做法

• 注册资源提供程序