使用 API 模拟生成响应
启用 API 模拟后,即可立即使用。
API 模拟会尽可能真实地响应它们收到的任何调用。在生成响应正文时,模拟将优先考虑用户提供的数据,依次查找 example 字段、default 值和 enum 字段。如果找到其中之一,它将用作示例,否则将根据被调用操作返回的数据类型生成 JSON 示例。
例如,考虑下面显示的 Company 数据类型定义。它不包含任何用户提供的示例。
激活模拟后,对 /company/{companyId} 资源进行的 GET 调用将根据数据类型的结构返回自动生成的 JSON 响应。
模拟完成了一些有趣的操作,包括为自定义响应标头(例如 x-my-custom-header)生成值,识别数组并创建适当的示例(例如 tags 属性),以及识别嵌套结构并为其生成值(例如 address 属性)。
API Designer 模拟支持内容协商,因此您可以使用 Accept 请求标头在多个选项(每个选项可能都有自己的示例)中选择应返回的正文,从而更改模拟返回的示例。
信息注释注释: 调用 API 模拟时,响应标头名称的大小写可能会发生变化。这不会破坏任何内容,因为 HTTP 标头名称不区分大小写。