跳到主要内容

脚本介绍

Apifox 包含一个基于Javascript的脚本引擎，通过脚本（JavaScript代码片段）可实现在接口请求或集合测试时添加动态行为。

脚本功能​

  1. 使用后置脚本功能测试（断言）请求返回结果的正确性。
  2. 使用前置脚本动态修改接口请求参数，如增加接口签名参数等。
  3. 使用脚本操作变量并在接口请求之间传递数据。
  4. 脚本可以直接 调用其他语言编写的程序，支持java(.jar)、python、php、js、BeanShell、go、shell、ruby、Lua 等语言编写的外部程序。
注意

Apifox 完美兼容 Postman 脚本语法，你可以将 Postman 脚本可以无缝迁移至 Apifox。

使用脚本​

前置脚本​

前置脚本是在请求发送前执行的代码片段。例如要在请求头中包含时间戳或在 URL 参数中发送随机的字母、数字、字符串等数据。

你可以在接口的“前置操作” tab 页中添加前置脚本，发送接口请求前将自动运行前置脚本。

后置脚本​

发送接口请求后执行的代码片段也称为后置脚本。主要用来断言请求返回的结果是否正确、将请求返回的结果数据写入环境变量等场景。

你可以在接口的“后置操作” tab 页中添加后置脚本，接口返回响应后将自动运行后置脚本。

全局脚本 / 分组脚本​

  1. 支持全局设置（在根目录里设置）前置操作、后置操作，设置后项目里的所有接口运行时都会生效。

  2. 支持分组里设置前置操作、后置操作，设置后分组里的所有接口运行时都会生效。

接口请求的执行流程如下：

[全局前置脚本] -> [分组前置脚本] -> [接口前置脚本] -> [发送接口请求] -> [返回接口结果] -> [全局后置脚本] -> [分组后置脚本] -> [接口后置脚本]。

脚本调试​

调试脚本可以在 前置脚本 和 后置脚本 里编写，使用console.log('hello')方式将调试信息写入控制台，打开 控制台 即可查看。