写点什么

Apipost 预执行脚本使用教程

作者:徐天
  • 2023-02-03
    北京
  • 本文字数:1323 字

    阅读完需:约 4 分钟

Apipost预执行脚本使用教程

提示:

预执行脚本是一个 请求发送前 执行的脚本。

预执行脚本的作用

预执行脚本可以完成以下作用:

  • 编写 JS 函数等实现复杂计算;

  • 变量的打印

  • 定义、获取、删除、清空环境变量

  • 定义、获取、删除、清空全局变量

  • 获取请求参数

  • 动态添加、删除一个 header 请求参数

  • 动态添加、删除一个 query 请求参数

  • 动态添加、删除一个 body 请求参数

  • 发送 HTTP 请求

编写 JS 函数等实现复杂计算

我们可以在预执行脚本中定义一个函数_random,

function _random(){    return '你好,中国' + Math.random();}
复制代码

它返回一个字符串:“你好中国”+随机数,此时可以通过

apt.globals.set("random_var", _random());
复制代码

将它赋值给全局变量 random_var。

预执行脚本打印调试变量

我们可以通过 console.log()将需要的变量打印在控制台,从而查看某个变量的当前值。如图上面示例中的

定义、获取、删除、清空环境变量

apt.variables.set("key", "value"); // 设置一个值为value的环境变量keyapt.variables.get("key"); // 获取环境变量key的值apt.variables.delete("key"); // 删除环境变量keyapt.variables.clear(); // 清空定义的全部环境变量
复制代码

定义、获取、删除、清空全局变量

apt.globals.set("key", "value");  // 设置一个值为value的全局变量keyapt.globals.get("key");  // 获取全局变量key的值apt.globals.delete("key");  // 删除全局变量keyapt.globals.clear(); // 清空定义的全部全局变量
复制代码

获取请求参数

通过 request 对象获取请求参数,详细可以参考《APIPOST 内置变量》。

动态添加、删除一个 header 请求参数

apt.setRequestHeader("key", "value"); // 动态添加一个键为key值为value的header参数apt.removeRequestHeader("key"); // 删除header参数中键为key的参数
复制代码

动态添加、删除一个 query 请求参数

apt.setRequestQuery("key", "value"); // 动态添加一个键为key值为value的query参数apt.removeRequestQuery("key"); // 删除query参数中键为key的参数
复制代码

动态添加、删除一个 body 请求参数

apt.setRequestBody("key", "value");// 动态添加一个键为key值为value的body参数apt.removeRequestBody("key");//删除body中键为key的参数
复制代码

发送 HTTP 请求

我们可以在预执行脚本中利用 AJAX 的 $.ajax 方法发送一个 http 请求。以下是一个简单的示例 demo:利用预执行脚本发送一个请求到https://echo.apipost.cn/get.php,并将响应结果的 bigint 赋值给了全局变量 bigint。

异步发送 HTTP 请求

$.ajax({    url:"https://echo.apipost.cn/get.php",    method:"POST",    headers:{        "content-type":"application/json"    },    timeout:"10000",    data:JSON.stringify({"email":"xxx@xxx.com","password":"123456"}),     success:function (response) {        apt.globals.set("bigint",response.bigint);     }});
复制代码

同步发送 HTTP 请求 (Apipost 7.0.4+ 支持)

await $.ajax({    url:"https://echo.apipost.cn/get.php",    method:"POST",    headers:{        "content-type":"application/json"    },    timeout:"10000",    data:JSON.stringify({"email":"xxx@xxx.com","password":"123456"}),     success:function (response) {        apt.globals.set("bigint",response.bigint);     }});
复制代码


用户头像

徐天

关注

还未添加个人签名 2022-12-29 加入

还未添加个人简介

评论

发布
暂无评论
Apipost预执行脚本使用教程_徐天_InfoQ写作社区