模拟脚本

模拟脚本使你能够创建智能模拟响应，在请求参数和响应数据之间建立逻辑关系。当你需要保持上下文准确性或反映请求值的模拟数据时，此功能至关重要。

使用场景

模拟脚本非常适合需要逻辑数据关系的场景：

常见示例

在响应中返回与请求 ID 匹配的用户 ID（例如，请求 ID 1001 → 响应包含 ID 1001）

确保时间一致性（例如，结束时间始终晚于开始时间）

计算相关字段（例如，根据数量和单价计算总价）

在响应载荷中反映请求参数

模拟脚本的工作原理

模拟脚本通过五步工作流处理数据：

智能模拟或其他模拟功能生成初始响应

模拟脚本访问 $$.mockResponse 和 $$.mockRequest 对象

JavaScript 逻辑从这些对象中检索并处理数据

$$.mockResponse.setBody 方法使用修改后的数据更新响应

模拟引擎返回最终处理后的响应

模拟脚本仅适用于 Smart mock。它们不适用于模拟期望或响应示例。

使用模拟脚本

启用并编写脚本

导航到 Mock 标签页，Mock Script 部分会显示在底部

开启脚本开关

在编辑器中编写脚本并保存

脚本参考

基础示例

此脚本的作用：

检索初始自动生成的模拟响应

通过以下方式修改响应：

将 page 设置为与请求的 page 参数匹配

将 total 设置为固定值 120

使用这些更改更新模拟响应

$$.mockRequest 对象

$$.mockRequest 对象表示传入的请求。它类似于 Postman 的 pm.request 对象，并带有额外功能。

关键方法：

方法/属性	描述
`getParam(key)`	从任意位置（query、body 等）检索参数
`headers`	访问 HTTP 头部
`cookies`	访问 cookie 值
`body`	访问请求主体
`formdata`	访问 form-data 参数
`urlencoded`	访问 URL 编码参数

使用示例：

$$.mockResponse 对象

$$.mockResponse 对象表示将被发回的响应。它类似于 Postman 的 pm.response 对象，并带有额外的控制方法。

关键方法：

方法	参数	描述
`setBody(body)`	any	设置响应主体
`setCode(code)`	number	设置 HTTP 状态码
`setDelay(duration)`	number (ms)	添加响应延迟（模拟延迟）
`json()`	-	以 JSON 形式检索响应
`headers`	-	访问/修改响应头部

使用示例：

FAQ

问：如何在模拟脚本中使用 Apidog 变量？

答：模拟脚本不能使用 Apidog 变量。

变量是 Apidog 客户端的一项功能，但模拟引擎独立运行，无法访问客户端侧变量。

问：如何在模拟脚本中使用日志语句？

答：模拟脚本不提供日志功能。

控制台是客户端侧功能，但模拟引擎单独运行，无法向客户端控制台输出日志。

问：为什么我不能在模拟脚本中使用 pm 对象？

答： pm 对象在模拟脚本中不可用。

模拟脚本在模拟服务器上执行，而前置/后置脚本在 Apidog 客户端上执行。它们是完全不同的执行环境，具有不同的可用对象和语法。

问：模拟脚本是否适用于模拟期望？

答：不，模拟脚本仅适用于 Smart mock。

当匹配到模拟期望时，模拟脚本不会执行。模拟脚本不适用于模拟期望或响应示例。

使用场景#

模拟脚本的工作原理#

使用模拟脚本#

启用并编写脚本#

脚本参考#

基础示例#

$$.mockRequest 对象#

$$.mockResponse 对象#

FAQ#

使用场景

模拟脚本的工作原理

使用模拟脚本

启用并编写脚本

脚本参考

基础示例

$$.mockRequest 对象

$$.mockResponse 对象

FAQ