接口之间如何传递数据
使用场景
接口B请求参数依赖于接口A返回的数据
实现思路
接口A使用后置操作->提取变量功能将请求完成后返回的数据提取作为变量
接口B对应的参数值直接引用前面设置的变量
使用示例
接口A使用后置操作->提取变量
将接口返回ResponseJSON数据里的token值提取到名为token的临时变量
接口B参数引用变量
对应的参数值里写入{{token}},即引用可名为token的变量。
登录态的接口如何处理
Apifox会自动保持Session/Cookie方式的登录态。
使用方式:
先执行登录接口,执行完成后全局Cookie会自动保存返回的Session/Cookie信息。然后运行其他接口,会自动带上Session/Cookie信息。
Token方式
Token方式是将登录凭证放在接口请求参数里。常见的有BasicAuth、BearerToken、APIKey等方式。
使用方法:
方法通过全局(项目概览页)、分组(分组设置)、接口(文档编辑页)的Auth设置授权信息,支持如下多种授权类型
方法手动将token写入Header或其他对应参数里。
示例:
BearerToken:设置一个名为Authorization的Header,设置值为BearereyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9yJpZCI6
方法在环境里的全局参数统一设置,所有接口运行时会自动加上全局参数,无需每个接口手动设置。
全自动登录方式
自动调用登录接口完成登录,无需手动登录
实现思路
使用环境变量保存登录需要的凭证。
如凭证有过期时间,使用环境变量保存登录凭证的过期时间。
创建一个公共脚本:
A、判断环境变量ACCESS_TOKEN是否有值,以及ACCESS_TOKEN_EXPIRES是否过期,如果存在且未过期,跳出执行,否则下一步。
B、使用psendRequest调用登录接口,将登录接口返回的登录凭证写入环境变量,过期时间也写入环境变量。
设置需要登录态的接口用例:
A、将用来验证登录态的参数值设置为{{ACCESS_TOKEN}}。
将header里的Authorization的设置为{{ACCESS_TOKEN}}。注意:这里也可以使用Cookie或其他位置的参数,请根据实际情况确定。此处也可以在环境里的额外参数统一设置,所有接口运行时会自动加上额外参数,无需每个接口手动设置。
B、在前置脚本里引用前面创建公共脚本。
示例:
示例脚本里的登录用户名和密码,是从环境变变量LOGIN_USERNAME和LOGIN_PASSWORD获取,如果你直接拷贝代码的话,记得要手动设置这两个环境变量。如果你们的token没有过期时间,可以将ACCESS_TOKEN_EXPIRES相关的代码去除。
// 定义发送登录接口请求方法
function sendLoginRequest() {
// 获取环境变量里的前置URL
const baseUrl = pm.environment.get('BASE_URL');
// 登录用户名,从环境变量LOGIN_USENAME获取,也可以写死(但不建议)
const username = pm.environment.get('LOGIN_USERNAME');
// 登录密码,从环境变量LOGIN_PASSWORD获取,也可以写死(但不建议)
const password = pm.environment.get('LOGIN_PASSWORD');
// 构造一个POST x-www-form-urlencoded 格式请求。这里需要改成你们实际登录接口的请求参数
const loginRequest = {
url: baseUrl + '/api/v1/login',
method: 'POST',
// 若 body 为 x-www-form-urlencoded 格式,mode 为 'urlencoded'
body: {
mode: 'urlencoded',
urlencoded: [
{ key: 'account', value: username },
{ key: 'password', value: password }
]
}
/*
// 若 body 为 form-data 格式,mode 为 'formdata'
body: {
mode: 'formdata',
formdata: [
{ key: 'account', value: username },
{ key: 'password', value: password }
]
}
// 若 body 为 raw 或 json 格式,mode 为 'raw'
body: {
mode: 'raw',
raw: JSON.stringify({ username: username, password: password }),
}
*/
};
// 发送请求
pm.sendLoginRequest(loginRequest, function (err, res) {
if (err) {
console.log(err);
} else {
// 读取接口返回的json数据
// 如果token信息存放在cookies的,可以使用res.cookies.get('token')方式获取
const jsonData = res.json();
// 将accessToken写入环境变量ACCESS_TOKEN
pm.environment.set('ACCESS_TOKEN', jsonData.data.accessToken);
// 将accessTokenExpires 过期时间写入环境变量 ACCESS_TOKEN_EXPIRES
pm.environment.set('ACCESS_TOKEN_EXPIRES', jsonData.data.accessTokenExpires);
}
});
}
// 获取环境变量的ACCESS_TOKEN
const accessToken = pm.environment.get('ACCESS_TOKEN');
// 获取环境变量里的 ACCESS_TOKEN_EXPIRES
const accessTokenExpires = pm.environment.get('ACCESS_TOKEN_EXPIRES');
// 如 ACCESS_TOKEN 没有值,或 ACCESS_TOKEN_EXPIRES 已过期,则执行发送登录接口请求
if (!accessToken || (accessTokenExpires && new Date(accessTokenExpires) <= new Date())) {
sendLoginRequest();
}
接口签名如何处理
注:统一处理,无需每个接口都处理
实现思路
创建一个公共脚本实现签名逻辑,读取接口请求参数,然后使用内置类库,如,生成签名。
将生成的签名sign作为参数加入请求,可使用以下两种方案:
方案脚本直接修改请求信息,注入一个签名参数,无需使用环境变量。。方案将生成的签名写入环境变量,接口设置参数时引用环境变量。
在接口的前置脚本里引用前面创建公共脚本。
如果签名算法是其他语言编写的,可使用fox.execute方法调用其他语言编写的程序
接口签名示例之微信支付签名算法
第一步:假设所有发送参数集合M,将集合M内非空参数值的参数按照参数名ASCII码从小到大排序,使用URL键值对的格式拼接成字符串stringA。
特别注意以下重要规则:
参数名ASCII码从小到大排序;
如果参数的值为空不参与签名;
参数名区分大小写;
传送的sign参数不参与签名;
第二步:在stringA最后拼接上key得到stringSignTemp字符串,并对stringSignTemp进行MD5运算,再将得到的字符串所有字符转换为大写,得到sign值signValue。
公共脚本实现之微信支付签名算法
// 获取预先设置为环境变量的 APPKEY
let key = pm.environment.get('APPKEY');
// 存放所有需要用来签名的参数
let param = {};
// 加入 query 参数
let queryParams = pm.request.url.query;
queryParams.each(item => {
if (item.value !== '') { // 非空参数值的参数才参与签名
param[item.key] = item.value;
}
});
// 加入 body 参数
if (pm.request.body) {
let formData;
switch (pm.request.body.mode) {
case 'formdata':
formData = pm.request.body.formdata;
break;
case 'urlencoded':
formData = pm.request.body.urlencoded;
break;
case 'raw':
// 如果没有 JSON 格式的请求 body,或 JSON 格式 body 不参与签名,可以删除这一段
let contentType = pm.request.headers.get('content-type');
if (
contentType
&& pm.request.body.raw
&& contentType.toLowerCase().indexOf('application/json') !== -1
) {
try {
let jsonData = JSON.parse(pm.request.body.raw);
/*
* 注意:通过脚本取出来的接口参数,如果参数包含变量,变量是不会替换成对应的值。如想要获取替换后的值,可使用`pm.variables.replaceIn`方法处理:
* let body = pm.variables.replaceIn(pm.request.body.raw);
* let jsonData = JSON.parse(body);
*/
for (let key in jsonData) {
let value = `${jsonData[key]}`; // 此处要注意如果值的实际类型不是 string 需要根据实际情况处理。
if (value !== '') { // 非空参数值的参数才参与签名
param[key] = value;
}
}
} catch (e) {
console.log('请求 body 不是 JSON 格式')
}
}
break;
default:
break;
}
if (formData) {
formData.each(item => {
if (item.value !== '') { // 非空参数值的参数才参与签名
param[item.key] = item.value;
}
});
}
}
// 取 key
let keys = [];
for (let key in param) {
// 注意这里,要剔除掉 sign 参数本身
if (key !== 'sign') {
keys.push(key);
}
}
// 参数名 ASCII 码从小到大排序(字典序)
keys.sort();
// 转成键值对
let paramPair = [];
for (let i = 0, len = keys.length; i < len; i++) {
let k = keys[i];
paramPair.push(k + '=' + encodeURIComponent(param[k])) // urlencode 编码
}
// 最后加上 key
paramPair.push('key=' + key);
// 拼接
let stringSignTemp = paramPair.join('&');
// console.log(stringSignTemp);
let sign = CryptoJS.MD5(stringSignTemp).toString().toUpperCase();
console.log(sign);
// 方案一:直接修改接口请求的 query 参数,注入 sign,无需使用环境变量。
// queryParams.upsert({
// key: 'sign',
// value: sign,
// });
// 方案二:写入环境变量,此方案需要在接口里设置参数引用环境变量
pm.environment.set('SIGN', sign);
接口签名示例之微信支付签名算法
百度翻译接口:百度翻译接口参考文档。
签名生成规则
第一步:将请求参数中的APPID(appi,翻译query(q,注意为UTF-8编码),随机数(salt),以及平台分配的密钥(可在管理控制台查看)按照appid+q+salt+密钥的顺序拼接得到字符串
第二步:对字符串1做md得到32位小写的sign。
注:
待翻译文本需为UTF-8编码在生成签名拼接appid+q+salt+密钥字符串时,q不需要做URLencode,在生成签名之后,发送HTTP请求之前才需要对要发送的待翻译文本字段q做URLencode
官方举例
官方举例:将apple从英文翻译成中文:
公共脚本实现
// 获取 Query 参数对象
var queryParams = pm.request.url.query;
// 获取 query 参数 q 的值
var q = queryParams.get('q');
// 获取预先设置为环境变量的 APPID 和 SECRET_KEY
var appid = pm.environment.get('APPID');
var secretKey = pm.environment.get('SECRET_KEY');
// 定义一个随机数(32768, 65536)之间
var salt = parseInt(Math.random() * (32769) + 32768, 10);
// 将随机数转换为字符串
salt = salt.toString();
console.log(salt);
// 定义一个由appid、要翻译的字符串、随机数、密钥组合成一个字符串
var str = appid + q + salt + secretKey;
console.log(str);
// 将 str 进行 md5 加密生成 sign
var sign = CryptoJS.MD5(str).toString();
// 方案一:直接修改接口请求的 query 参数,注入 salt 和 sign,无需使用环境变量。
queryParams.upsert({
key: 'salt',
value: salt,
});
queryParams.upsert({
key: 'sign',
value: sign,
});
// 方案二:将 salt 和 sign 写入环境变量,此方案需要在接口里设置参数引用环境变量
// pm.environment.set('SALT', salt);
// pm.environment.set('SIGN', strmd5);
文章为作者独立观点,不代表 股票程序化软件自动交易接口观点