通过

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

使用 Azure Spring Apps 企业计划将 API 门户迁移到 Azure API 管理

注意

基本、标准和企业计划将从 2025 年 3 月中旬开始弃用，停用期为 3 年。 建议转换到 Azure 容器应用。 有关详细信息，请参阅 Azure Spring Apps 停用公告。

标准消耗和专用计划将于 2024 年 9 月 30 日开始弃用，并在六个月后完全关闭。 建议转换到 Azure 容器应用。 有关详细信息，请参阅将 Azure Spring Apps 标准消耗和专用计划迁移到 Azure 容器应用。

本文适用于： ❎ 基本计划/标准计划 ✅ 企业计划

本文介绍如何将 API 门户迁移到 Azure API 管理。

Azure API 管理提供了一个集中的界面，用于直接从浏览器查看 API 定义和测试特定 API 路由。 它还支持单一登录 (SSO)，以提高安全性和无缝访问。 使用 Azure Spring Apps 从 API 门户迁移到 Azure API 管理可增强可伸缩性、安全性以及与其他 Azure 服务的集成。

先决条件

创建 API 管理实例

使用以下步骤创建 API 管理实例：

  1. 在 Azure 门户的搜索栏中搜索“API 管理”。

  2. 从结果中选择“API 管理”，然后选择“创建”。

  3. 提供以下所需信息：

    • 订阅：请选择服务的 Azure 订阅。
    • 资源组：选择一个现有资源组，或选择“新建”以创建一个新资源组。
    • 区域：选择 API 管理实例的位置或区域。
    • 资源名称：提供 API 管理实例的全局唯一名称。
    • 组织名称：指定组织的名称。
    • 管理员电子邮件：提供用于与 API 管理实例相关的通知的电子邮件地址。

  4. 根据用例选择定价层。 之后可以随时升级或更改定价层。

  5. 配置可选设置，例如监视和虚拟网络设置。

  6. 选择“查看 + 创建”，查看设置并验证配置。

  7. 完成验证后，选择“创建”。 部署可能需要 30 到 40 分钟。

  8. 部署完成后，导航到“API 管理服务”页以查看新创建的服务。

在 API 管理中导入公开的 API

在 API 管理中导入 API 有两个选项：手动添加 API 或导入 API 规范文件。

手动添加 API

使用以下步骤手动添加 API：

  1. 在 Azure 门户中，导航到 API 管理实例。 在 API 部分下，选择“添加 API”。

  2. 在“定义新的 API”窗格中，选择“HTTP”选项以手动定义 HTTP API。

  3. 提供以下 API 基本信息值，然后选择“创建”进行保存：

    • 显示名称：为 API 提供名称。
    • 名称：输入 API 的唯一标识符。
    • Web 服务 URL：指定容器应用的后端 API 的基础 URL。
    • API URL 后缀：定义此 API 的后缀，例如，/api/customers-service。

  4. 若要创建新的 API 终结点，请选择“添加操作”，然后使用以下步骤：

    1. 提供常规信息。 输入“显示名称”和“名称”。
    2. 提供作的详细信息，例如 Http 谓词 - GET、POST等 - URL、查询参数、请求和响应。
    3. 添加所有操作后，保存 API。

  5. 选择添加的 API 的名称。 可以在“设计”选项卡中看到添加的所有操作。

导入 API 规范文件

如果 API 有 OpenAPI 规范（Swagger 定义），则可以使用以下步骤直接导入 API 管理：

  1. 在 Azure 门户中，导航到 API 管理实例。

  2. 在 API 下打开 API部分。

  3. 选择“添加 API”。

  4. 对于“从定义创建”，请选择 OpenAPI 选项，该选项为 REST API 创建一个标准的、与语言无关的接口。

  5. 使用以下步骤从 OpenAPI 规范创建 API：

    1. 如果有本地 API 规范文件，请选择“选择文件”上传文件。 或者，提供 OpenAPI 规范可公开访问的 URL。
    2. 可以通过为 API 提供显示名称、名称以及API URL 后缀的值来进一步优化 API 设置。
    3. 选择“创建”以保存配置。

  6. 选择添加的 API 的名称。 可以在“设计”选项卡中看到添加的所有操作。

在 API 管理中试用 API

Azure API 管理在 Azure 门户中提供内置的测试控制台，无需外部工具即可轻松与 API 交互。 使用以下步骤测试 API：

  1. 在 Azure 门户中，导航到 API 管理实例。

  2. 在 API 部分下，从列表中选择要测试的 API。

  3. 选择一个操作。 在 API 的概述页中，可以看到可用操作（终结点）列表。 选择要测试的操作。

  4. 选择“测试”选项卡，在 Azure 门户中将其打开。

  5. 配置请求参数。 根据不同的 API 方法，输入请求所需的参数，例如路径参数、查询参数、标头或正文。 如果 API 需要 Authorization Token，请确保将其包含在标头中。

  6. 发送请求。 提供请求详细信息后，选择“发送”。 API 的响应直接显示在 Azure 门户中，包括响应代码、响应正文以及标头。

  7. 检查响应。 查看响应数据、状态代码以及可能指示 API 或请求问题的任何错误消息。

将单一登录迁移到 API 管理

如果在 API 门户中启用单一登录 (SSO)，并且想要对 API 管理的请求进行身份验证，请使用以下步骤在 API 管理中配置标识：

  1. 在 Microsoft Azure 门户中，转到 API 管理实例。

  2. 导航到“开发人员门户”>“标识”。

  3. 依次选择“添加”和“Azure Active Directory”。

  4. 填写必填字段：

    • 客户端 ID：已注册Microsoft Entra ID 应用程序的应用程序或客户端 ID。
    • 客户端密码：Microsoft Entra ID 应用程序的客户端密码。
    • 登录租户：Microsoft Entra ID 租户的域名，例如 yourcompany.onmicrosoft.com
    • 重定向 URL：通常为 https://{your-apim-instance}.developer.azure-api.net/signin。

  5. 选择“保存”以保存标识提供者。

在保存新添加的标识提供者之前，需要将重定向 URL 添加到 Microsoft Entra ID 客户端应用允许的重定向 URL 列表中。

有关 API 管理的更多配置信息，请参阅 API 管理文档。