导入 OpenAPI 规范

适用于:所有 API 管理层级

本文介绍如何导入 https://conferenceapi.chinacloudsites.cn?format=json 中的“OpenAPI 规范”后端 API。 此后端 API 由 Microsoft 提供并托管在 Azure 上。 此外,介绍如何测试 APIM API。

在本文中,学习如何:

  • 使用 Azure 门户、Azure CLI 或 Azure PowerShell 导入 OpenAPI 规范
  • 在 Azure 门户中测试 API

注意

API 导入限制和已知问题中记录了 API 导入限制。

必备条件

导入后端 API

  1. Azure 门户,导航到 API 管理实例。

  2. 在左侧菜单中,选择“API”>“+ 添加 API”。

  3. 在“从定义创建”下,选择“OpenAPI”。

    从门户中的 OpenAPI 规范创建 API 的屏幕截图。

  4. 输入 API 设置。 可以在创建过程中设置这些值,也可以稍后转到“设置”选项卡来配置这些值。在导入和发布第一个 API 教程中对这些设置进行了说明。

  5. 选择“创建” 。


author: Johnnytechn ms.service: api-management ms.topic: include ms.date: 04/12/2023 ms.author: v-johya

在门户中测试新的 API

可直接从管理门户调用操作,这为管理员查看和测试 API 的操作提供了一种方便的方式。

  1. 选择上一步中创建的 API。

  2. 选择“测试”选项卡。

  3. 选择操作。

    该页将显示查询参数的字段和标头的字段。

    注意

    在测试控制台中,API 管理自动填充 Ocp-Apim-Subscription-Key 标头,并配置内置全访问订阅的订阅密钥。 此密钥允许访问 API 管理实例中的每个 API。 可选择性地通过选择 HTTP 请求旁的“眼睛”图标来显示 Ocp-Apim-Subscription-Key 标头。

  4. 根据操作,输入查询参数值、标头值或请求正文。 选择“发送”。

    如果测试成功,后端会响应并显示“200 正常”和一些数据。

若要调试 API,请参阅教程:使用请求跟踪调试 API

追加其他 API

可以为不同服务公开的 API 撰写 API,包括:

  • OpenAPI 规范
  • SOAP API
  • Azure 应用服务中托管的 Web 应用
  • Azure 函数应用
  • Azure 逻辑应用
  • Azure Service Fabric

按照以下步骤将其他 API 追加到现有 API。

注意

导入另一个 API 时,操作将追加到当前 API 后面。

  1. 在 Azure 门户中转到自己的 Azure API 管理实例。

    转到 Azure API 管理实例

  2. 在概述页面上或左侧的菜单上选择“API” 。

    选择“API”

  3. 单击要将另一个 API 追加到的 API 旁边的“...”

  4. 从下拉菜单中选择“导入”。

    选择“导入”

  5. 选择要从中导入 API 的服务。

    选择服务

根据 OpenAPI 规范进行验证

可以配置 API 管理验证策略,以根据 OpenAPI 规范中的架构验证请求和响应(或其元素)。 例如,使用 validate-content 策略来验证请求或响应正文的大小或内容。

后续步骤