Apifox登录态,无需调用登录接口实现全自动登录
一、全自动登录
运行接口用例的时候,自动调用登录接口完成登录,而无需手动登录。
#期望效果
#运行接口用例的时候,自动完成登录,而无需手动登录。
#自动登录过一次后,保存登录态,避免每次执行用例都调用登录接口。
二、使用 环境变量(如:ACCESS_TOKEN,BASE_URL,USERNAME,PASSWORD等)保存登录需要的凭证。
三、公共脚本示例
1、新建公共脚本
2、脚本代码
// 定义发送登录接口请求方法
function sendLoginRequest() {
// 获取环境里的 前置URL
const baseUrl = pm.environment.get("BASE_URL");
// 登录用户名,这里从环境变量 LOGIN_USERNAME 获取,也可以写死(但是不建议)
const username = pm.environment.get("YG_USERNAME");
// 登录用户名,这里从环境变量 LOGIN_PASSWORD 获取,也可以写死(但是不建议)
const password = pm.environment.get("YG_PASSWORD");
// 构造一个 POST x-www-form-urlencoded 格式请求。这里需要改成你们实际登录接口的请求参数。
const loginRequest = {
url: baseUrl + "/api/v1/users/login",
method: "POST",
// body 为 json 格式
header: {
"Content-Type": "application/json",
"tenant": "lfc",
// 注意:header 需要加上 Content-Type
},
body: {
mode: 'raw',// 此处为 raw
raw: JSON.stringify({ username: username, password: password }), // 序列化后的 json 字符串
}
};
// 发送请求。
// pm.sendrequest 参考文档: https://www.apifox.cn/help/app/scripts/api-references/pm-reference/#pm-sendrequest
pm.sendRequest(loginRequest, function (err, res) {
if (err) {
console.log(res);
console.log(err);
} else {
// 读取接口返回的 json 数据。
// 如果你的 token 信息是存放在 cookie 的,可以使用 res.cookies.get('token') 方式获取。
// cookies 参考文档:https://www.apifox.cn/help/app/scripts/api-references/pm-reference/#pm-cookies
const jsonData = res.json();
console.log(jsonData);
// 将 accessToken 写入环境变量 ACCESS_TOKEN
pm.environment.set("ACCESS_TOKEN", jsonData.data.accessToken);
// // 将 accessTokenExpires 过期时间写入环境变量 ACCESS_TOKEN_EXPIRES
// pm.environment.set(
// "ACCESS_TOKEN_EXPIRES",
// jsonData.data.updateTime
// );
}
});
}
// 获取环境变量里的 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 ||
// (new Date(accessTokenExpires) <= new Date())
// )
{sendLoginRequest();}
#{sendLoginRequest();}