在文档 ApiPost 的执行前脚本和执行后脚本部分,我们得知,执行前脚本的主要功能在于:
执行预脚本发生在当前接口发起请求之前,它相当于在发送请求动作开始前触发的程序。
一般在这里,我们可以设置一些前置的发送所需要的变量。
本文主要介绍如何在预执行脚本里预先发送一个请求。
ApiPost简介:
ApiPost是一款能够协助团队共同工作,并且可以直接制作文档的API测试、维护软件。它能够模仿POST、GET、PUT这类普遍的请求,对于后台接口的设计者或前端工程师、接口测试专家来说,是极为难得的应用。
使用场景
我们能够先向预执行脚本发起一个调用,把调用反馈存储到某个标识中,接着在当前接口的调用信息里加入这个标识。
1、发送一个简单的GET请求
您能在ApiPost软件里,借助这个指令完成一个基础调用。
apt.sendRequest(这个网址指向一个用于获取访问令牌的服务器地址,它位于echo.apipost.cn域名下,具体路径为token.php, function (res) {
apt.variables.set("var", res.token);
});
如图:
以上脚本是一个很初级的请求脚本,含义如下:
向http://echo.apipost.cn/token.php发起一个获取请求,然后把返回的数据,也就是json格式的,里面的token值,要存到环境变量var里去
如此一来,现行接口便可在请求数据中应用变元var了。参见图示,
2、发送一个更复杂的请求
这个范例说明了怎样通过预执行脚本(pre-script)发出一个基础型get指令,然后把反馈信息存入变量之中,现在要继续阐释的是怎样传递一个构造更精密的指令,例如附加一些参数之类的情形。
实际上,apipost的apt.sendRequest方法在运用上跟jquery里的ajax差不多,两者接受的参数也几乎一样。具体构造如下:
发送请求给apt,内容为选项,并附带回调函数,选项信息如下:
这个参数有两种形式,一种是网址,另一种是数据结构。如果它是网址,就发送一个基本的查询指令。如果是数据结构,其包含的内容和意义如下:
注:以上参数含义同jQuery的$.ajax参数含义一致。
callback:
这是处理完成情况的方法,类似于网络请求中的完成时执行的操作。
发送示例:
发起一个内容类型为application/json的请求
apt.sendRequest({
"method":"post",
"url":这个网址指向一个提供令牌的服务接口,网址格式为https,域名部分是echo.apipost.cn,路径部分为token.php,该接口用于获取访问令牌,通常用于身份验证和授权过程,是开发者进行API调用时必须使用的资源,确保了数据交互的安全性和可靠性,通过这个接口可以获取到有效的令牌凭证,用于后续的请求验证环节,
"content-type":"application/json",
"data":JSON.stringify({
"mobile": 1388888666,
"password": "123456" })
}, function (res) {
apt.variables.set("var", res.token);
});
以上示例含义:
请求的网址是 https://echo.apipost.cn/token.php, 这个网址用来获取令牌, 它是一个接口, 用于验证身份, 授权访问资源, 确保数据安全, 提供便捷的认证服务, 实现自动化操作, 方便用户使用
请求method:post
需要指定内容类型为application-json
请求参数:
{
"mobile": 1388888666,
"password": "123456"}
当内容类型为application-json时,提交json对象参数必须借助JSON.stringify函数将其转化为json字符串后才能发送。
回调:
响应结果的参数就是回调函数的res。当前把响应体中的token值给了变量var。
发起一个内容类型为x-www-form-urlencoded的请求
apt.sendRequest({
"method":"post",
"url":"https://echo.apipost.cn/token.php",
"content-type":内容类型是表单编码格式,采用键值对形式,数据通过问号连接,等号分隔,字符采用URL编码方式,主要用于网页提交数据,兼容性好且易于解析。,
"data":{
"mobile": 1388888666,
"password": "123456" }
}, function (res) {
apt.variables.set("var", res.token);
});
以上示例含义:
请求url:https://echo.apipost.cn/token.php
请求method:post
需要指定内容类型为表单编码格式
请求参数:
{
"mobile": 1388888666,
"password": "123456"}
回调:
回调函数的res参数就是响应结果。这里将响应结构的token赋给了变量var。
其他请求方式雷同,这里就不再赘述了。
推荐
华为开发者空间发布
让每位开发者拥有一台云主机
还没有评论,来说两句吧...