设置 API 中心门户

本文介绍如何设置 API 中心门户（预览版），这是组织中开发人员和其他利益干系人可用于在 API 中心发现 API 的 Azure 托管网站。 已登录用户可以浏览和筛选 API，并可以查看 API 详细信息，例如 API 定义和文档。 用户对 API 信息的访问权限基于 Microsoft Entra ID 和 Azure 基于角色的访问控制。

注释

API 中心门户目前以预览版提供。

小提示

Azure API 管理和 Azure API 中心都为开发人员提供了 API 门户体验。 比较门户

先决条件

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

• 在与 Azure 订阅关联的 Microsoft Entra 租户中创建应用注册的权限，以及授予对 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。 可以在应用注册的 “概述 ”页上找到此值。

配置并发布 API 中心门户

创建 API 中心门户应用注册后，需要配置并发布 API 中心门户。 在 Azure 门户中完成以下步骤。

1. 在 Azure 门户中，导航到 API 中心。
2. 在左侧菜单中的“API 中心门户”下，选择“门户设置”。
3. 在“标识提供者”选项卡上，选择“开始设置”。 在显示的屏幕上执行以下操作：
   1. 在“客户端 ID”中，输入在上一部分中创建的应用注册的“应用程序(客户端) ID”。
   2. 确认“重定向 URI”是你在应用注册中配置的值。
   3. 选择“保存 + 发布”。
4. 在“站点配置文件”选项卡上，输入你想要显示在 API 中心门户顶部栏中的网站名称。 选择“保存 + 发布”。
5. 在“API 可见性”选项卡上，添加你希望能够在门户中发现的 API 筛选器（可选）。 选择“保存 + 发布”。 详细了解 API 可见性

现在可以访问 API 中心门户：

• 在“门户设置”页面上，选择“查看 API 中心门户”以在新选项卡页中打开该门户。
• 或者，在浏览器中输入以下 URL（请将其中的 <service-name> 和 <location> 分别替换为 API 中心的名称及其部署位置）：
  https://<service-name>.portal.<location>.azure-api-center.ms

API 可见性

API 可见性设置控制 API 中心门户用户可发现（可以看到）哪些 API。 API 中心门户使用数据平面 API 来检索和显示 API，默认会检索 API 中心内的所有 API。 可见性设置适用于 API 中心门户的所有用户。

若要仅显示特定的 API，请转到 API 中心门户设置中的“API 可见性”选项卡。 在此处，可以根据内置或自定义 API 元数据属性添加 API 筛选条件。 例如，可以选择仅显示某些类型（如 REST 或 GraphQL）或基于某些规范格式（例如 OpenAPI）的 API。 此外，还可以选择对 API 进行分类的自定义元数据属性的值。

.

通过 Microsoft Entra 用户和组启用登录到门户

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

重要

默认情况下，API 中心的其他管理员无权访问 API 中心门户中的 API。 请务必将 Azure API 中心数据读取者角色分配给自己和其他管理员。

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

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

注释

若要简化新用户的访问配置，建议将角色分配给 Microsoft Entra 组并配置动态组成员身份规则。 若要了解详细信息，请参阅在 Microsoft Entra ID 中创建或更新动态组。

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

注释

系统会提示第一个登录到门户的用户同意 API 中心门户应用注册请求的权限。 此后，系统不会提示其他已配置的用户同意。

启用对 API 的测试控制台的访问权限

可以将用户设置配置为在 API 中心精细地授权访问 API 及其特定版本。 例如，将某些 API 版本配置为使用 API 密钥进行身份验证，并创建仅允许特定用户使用这些密钥进行身份验证的访问策略。 此策略也适用于 API 中心门户中 API 的“试用此 API”功能，确保只有具有相应访问策略的门户用户才能将这些 API 版本使用测试控制台。 详细了解如何授权访问 API

API 中心门户中的 API 发现和使用

API 中心门户支持和简化组织中使用和创建 API 的开发人员的工作。 登录用户可以：

• 按名称搜索 API 或使用 AI 辅助语义搜索

• 按类型或生命周期阶段筛选 API

• 查看 API 详细信息和定义 ，包括终结点、方法、参数和响应格式

• 将 API 定义下载 到本地计算机或在 Visual Studio Code 中打开它们

• 试用 支持 API 密钥身份验证或 OAuth 2.0 授权的 API

使用 AI 进行搜索

在 Azure API 中心的标准计划中，API 中心门户使用基于 AI 的 语义搜索 来补充基于基本名称的 API 搜索，这些搜索基于 API 名称和说明。 用户可以使用自然语言查询搜索 API，从而更轻松地根据 API 的意图查找 API。 例如，如果开发人员搜索“我需要 API 进行库存管理”，则门户可以建议相关的 API，即使它们的姓名或说明不包含这些确切字词。

小提示

如果使用 Azure API 中心的免费计划，则可以 轻松地升级到 标准计划，以启用完整的服务功能，包括 API 中心门户中的语义搜索。

若要在登录到 API 中心门户时使用 AI 辅助搜索，请在搜索框中单击，选择 “使用 AI 进行搜索”，然后输入查询。

API 管理和 API 中心门户

Azure API 管理和 Azure API 中心服务均向开发人员提供用于发现和使用 API 的门户：

• 在 API 管理开发人员门户中，用户可以查找托管的 API、了解其用法、请求访问和测试这些 API。
• API 中心门户（预览版）是一个多网关门户，用户可以在其中发现和筛选组织的完整 API 清单。

虽然这两个门户有一些共同的特征，但它们其实有着明显的差别。 下表比较了当前功能，以帮助你确定要使用哪个门户。 有些组织可能偏向于一个门户，而有些组织则可能需要这两个门户。

功能 / 特点	API 管理开发人员门户	API 中心门户（预览版）
搜索和筛选 API 清单	仅 API 管理实例	所有 API1
查看 API 详细信息和定义	✔️	✔️
查看 API 文档	✔️	✔️
自定义品牌	✔️	仅名称
与 Microsoft Entra ID 集成	✔️	✔️
添加自定义小组件	✔️	❌
使用 WordPress 进行自定义	✔️	❌
在测试控制台中测试 API	✔️	✔️
订阅 API	✔️	❌
查看 API 使用情况分析	✔️	❌

¹ API 中心门户可以包含组织中的所有 API，包括在 Azure API 管理和其他平台中管理的 API，以及非托管 API 和正在开发的 API。

相关内容

• 在 Visual Studio Code 中启用和查看 Azure API 中心门户