教程:模拟 API 响应
适用于:所有 API 管理层级
后端 API 可导入到 API 管理 (APIM) API,或者手动创建和管理。 本教程中的步骤将展示如何实现以下操作:
- 使用 API 管理创建空白 HTTP API
- 手动管理 HTTP API
- 设置 API 策略,使其返回模拟响应
通过此方法,即使后端无法发送真实响应,开发人员也可继续实现和测试 API 管理实例。
在许多情况下,模拟响应功能非常有用:
- 当以 API 的结构设计为主,后端实现为辅时。 或者并行开发后端时。
- 当后端暂时不可正常运行或不可缩放时。
在本教程中,你将了解如何执行以下操作:
- 创建测试 API
- 将操作添加到测试 API
- 启用响应模拟
- 测试模拟 API
先决条件
- 了解 Azure API 管理术语。
- 了解 Azure API 管理中策略的概念。
- 完成以下快速入门:创建 Azure API 管理实例。
创建测试 API
本部分中的步骤展示了如何创建不带后端的 HTTP API。
登录到 Azure 门户,然后导航到 API 管理实例。
选择“API”>“+ 添加 API”>“HTTP”磁贴。
在“创建 HTTP API”窗口中,选择“完整”。
输入“测试 API”作为“显示名称”。
为“产品”选择“无限制” 。
请确保已在“网关”中选择“托管”。
选择“创建” 。
将操作添加到测试 API
API 公开一个或多个操作。 在本部分中,将操作添加到你创建的 HTTP API。 完成本部分中的步骤之后调用该操作会触发错误。 完成启用响应模拟部分中的步骤后,将不会出现任何错误。
选择上一步中创建的 API。
选择“+ 添加操作”。
在“前端”窗口中,输入以下值。
设置 值 说明 显示名称 测试调用 显示在开发人员门户中的名称。 URL(HTTP 谓词) GET 选择预定义的 HTTP 谓词之一。 URL /test API 的 URL 路径。 说明 操作的可选说明,用于在开发人员门户中向使用此 API 的开发人员提供文档。 选择“URL”、“显示名称”和“说明”字段下面的“响应”选项卡。 在此选项卡上输入设置以定义响应状态代码、内容类型、示例和架构。
选择“+ 添加响应”,并从列表中选择“200 OK” 。
在右侧的“表示形式”标题下,选择“+ 添加表示形式”。
在搜索框中输入“application/json”,选择“application/json”内容类型。
在“示例”文本框中,输入
{ "sampleField" : "test" }
。选择“保存”。
虽然此示例中不需要,但可以在其他选项卡上为 API 操作配置更多设置,包括:
选项卡 | 说明 |
---|---|
查询 | 添加查询参数。 除了提供名称和说明以外,还可以提供可分配给查询参数的值。 可以将其中一个值标记为默认值(可选)。 |
请求 | 定义请求内容类型、示例和架构。 |
启用响应模拟
选择在创建测试 API 中创建的 API。
在右侧窗口中,确保已选中“设计”选项卡。
选择添加的测试操作。
在“入站处理”窗口中,选择“+ 添加策略” 。
从库中选择“模拟响应”。
在“API 管理响应”文本框中,键入 200 OK, application/json。 此项选择指示 API 应返回上一部分中定义的响应示例。
选择“保存”。
提示
将显示一个带有文本“模拟已启用”的黄色栏。 这表示从 API 管理返回的响应是由模拟策略模拟的,不是由后端生成的。
测试模拟 API
选择在创建测试 API 中创建的 API。
选择“测试”选项卡。
确保选中“测试调用”API,然后选择“发送”进行测试调用。
“HTTP 响应”显示提供的 JSON,如本教程第一部分中的示例所示。
后续步骤
在本教程中,你了解了如何执行以下操作:
- 创建测试 API
- 将操作添加到测试 API
- 启用响应模拟
- 测试模拟 API
转到下一教程: