Mock 脚本

有时，你需要根据请求参数返回对应的 Mock 数据，或者维护不同属性之间的逻辑关系。

例如：

当请求用户 ID 为 1001 的信息时，返回的数据应包含该 ID，且值为 1001。

当 Mock 数据包含开始时间和结束时间等相关属性时，结束时间应晚于开始时间。

这些逻辑关系可以通过 Mock 脚本来实现。

工作原理

Mock 脚本的基本实现原理如下：

使用智能 Mock 或其他 Mock 功能生成初始响应数据，这些数据可能还未满足所有约束条件。

使用 Mock 脚本访问 $$.mockResponse 对象或 $$.mockRequest 对象。

从这两个对象中获取数据，并编写 JavaScript 实现所需的逻辑。

使用 $$.mockResponse.setBody 方法，将修改后的数据写入响应内容。

Mock 引擎返回最终的响应数据。

使用 Mock 脚本

点击 Mock 选项卡，定位到 Mock 脚本区域

打开脚本开关来启用它

编写脚本并保存

脚本参考

`$$.mockRequest` 对象

$$.mockRequest 对象代表 Mock 脚本中的传入请求，类似于 Postman 的 pm.request 对象，但它提供了一些额外功能。

getParam(key: string) 方法：获取请求中的参数，无论参数位于 （查询字符串、请求体等） 哪个位置。

访问 Cookies：允许你获取请求中的 cookie 值。

$$.mockResponse 对象

$$.mockResponse 对象代表将要发送回去的 Mock 响应，类似于 Postman 的 pm.response 对象，但提供了更多控制 Mock 响应的方法。

setBody(body: any) 方法：设置响应体。

setCode(code: number) 方法：设置响应的 HTTP 状态码。

setDelay(duration: number) 方法：为 Mock 响应添加延迟，模拟网络延迟。

Mock 脚本示例

这个脚本做了这些事：

先获取一个初始的 Mock 响应（自动生成的）

然后修改这个响应：

把 page 值设置为请求中的值

设置一个固定的 total 值

最后用这些修改更新 Mock 响应

Mock 自定义脚本，不能用于前置/后置脚本中。

其它示例

模拟分页：

更多示例参考：

常见问题

如何在 Mock 脚本中使用 Apifox 变量？

Mock 脚本不能使用变量。这是因为变量是 Apifox 客户端的功能，但 Mock 引擎不是客户端的一部分，所以它无法引用客户端中的变量。

如何在 Mock 脚本中使用 log 语句输出到控制台？

为什么我不能在 Mock 脚本中使用 pm 对象？

工作原理#

使用 Mock 脚本#

脚本参考#

$$.mockRequest 对象#

$$.mockResponse 对象#

Mock 脚本示例#

其它示例#

常见问题#

工作原理

使用 Mock 脚本

脚本参考

`$$.mockRequest` 对象

$$.mockResponse 对象

Mock 脚本示例

其它示例

常见问题