自定义您的 API 中心门户站点

本文介绍可在 API 中心门户中自定义的设置（预览版）。 API 中心门户是一个 Azure 托管的网站，供开发人员和组织内的其他利益干系人用于在 API 中心发现 API。

若要设置 API 中心门户以供初始使用和登录，请参阅 设置 API 中心门户。

门户设置页

在 Azure 门户中配置 API 中心门户设置。 若要访问设置页，请执行以下作：

1. 在 Azure 门户中导航到 API 中心。
2. 在 API 中心门户下，选择 “设置”。
3. 单击选项卡以查看和自定义设置。
4. 选择 “保存 + 发布 ”以应用更改。

网站配置文件

在 “网站配置文件 ”选项卡上，可以选择提供显示在已发布门户顶部栏中的自定义名称。

API 可见性

在 “API 可见性 ”选项卡上，控制 API 中心门户用户可发现哪些 API（可见）。 可见性设置适用于 API 中心门户的所有用户。

API 中心门户使用 Azure API 中心数据平面 API 在 API 中心检索和显示 API，默认情况下，使用 Azure RBAC 权限显示已登录用户的所有 API。

若要仅显示特定的 API，请基于内置属性为 API 添加筛选器条件。 例如，选择仅显示某些类型的 API（如 REST 或 GraphQL），或基于某些规范格式（如 OpenAPI）。

匿名访问

在 “API 可见性 ”选项卡上，可以选择启用对 Azure API 中心数据平面 API 的匿名读取访问，这样，未经身份验证的用户就可以通过直接 API 调用来发现 API 清单。 例如，启用此设置，以便在自行托管 API 中心入口时，使未经身份验证的用户能够发现 API。

语义搜索

如果在 “语义搜索 ”选项卡上启用，API 中心门户使用基于 AI 辅助的 语义搜索 来补充基于基本名称的 API 搜索，这些搜索基于 API 名称、说明和（可选）自定义元数据。 语义搜索仅在 标准 计划中可用。

用户可以使用自然语言查询搜索 API，从而更轻松地根据 API 的意图查找 API。 例如，如果开发人员搜索“我需要 API 进行库存管理”，则门户可以建议相关的 API，即使 API 名称或说明不包含这些确切字词。

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

自定义元数据

在“ 元数据 ”选项卡上，可以选择要在 API 详细信息和语义搜索中公开的 自定义元数据 属性。

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

可以将用户设置配置为在 API 中心精细地授权访问 API 及其特定版本。 例如，将某些 API 版本配置为使用 API 密钥进行身份验证，并创建仅允许特定用户使用这些密钥进行身份验证的访问策略。

访问策略也适用于 API 中心门户中 API 的“试用此 API”功能，确保只有具有相应访问策略的门户用户才能对这些 API 版本使用测试控制台。 详细了解如何授权访问 API

相关内容

• 设置 API 中心门户
• 在 Visual Studio Code 中启用和查看 Azure API 中心门户
• 自托管 API 中心门户