登录态(Auth)如何处理
Apifox 使用文档
# 登录态(Auth)如何处理
# 常见处理方式
# 一、Session/Cookie 方式
Apifox 会自动保持 Session/Cookie 方式的登录态。
使用方法:
- 先执行登录接口,执行完成后全局 Cookie 会自动保存返回的 Session/Cookie 信息。
- 然后运行其他接口,会自动带上 Session/Cookie 信息。
注意
Session/Cookie 方式可以按下文方法实现全自动登录
。
# 二、Token 方式
Token 方式是将登录凭证放在接口请求参数里(通常会放在 Header)。常见的有Basic Auth
、Bearer Token
、API Key
等方式。
使用方法:
- 手动将 token 写入 Header 或其他对应参数里(推荐使用 环境变量 存放 token)。示例:
- Bearer Token:设置一个名为
Authorization
的 Header,设置值为Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9yJpZCI6
(或者使用环境变量,设置值为Bearer
)
- Bearer Token:设置一个名为
- 也可以在 环境 里的
额外参数
统一设置,所有接口运行时会自动加上额外参数
,无需每个接口手动设置。
注意
Token 方式可以按下文方法实现全自动登录
。
# 三、全自动登录
运行接口用例的时候,自动调用登录接口完成登录,而无需手动登录。
使用方法:
- 请看下文
# 全自动登录实现方式
# 期望效果
- 运行接口用例的时候,自动完成登录,而无需手动登录。
- 自动登录过一次后,保存登录态,避免每次执行用例都调用登录接口。
# 实现思路
- 使用 环境变量(如:
ACCESS_TOKEN
)保存登录需要的凭证。 - 如凭证有过期时间,使用环境变量(如:
ACCESS_TOKEN_EXPIRES
)保存登录凭证的过期时间。 - 创建一个 公共脚本 :
- 判断环境变量
ACCESS_TOKEN
是否有值,以及ACCESS_TOKEN_EXPIRES
是否过期,如果存在且未过期,跳出执行,否则下一步。 - 使用 pm.sendRequest 调用登录接口,将登录接口返回的登录凭证写入环境变量,过期时间也写入环境变量。
- 判断环境变量
- 设置需要登录态的接口用例:
- 将用来验证登录态的参数值设置为
{{ACCESS_TOKEN}}
。- 将 header 里的
Authorization
的设置为{{ACCESS_TOKEN}}
。注意:这里也可以使用 Cookie 或其他位置的参数,请根据实际情况确定。 - 此处也可以在 环境 里的 额外参数 统一设置,所有接口运行时会自动加上 额外参数,无需每个接口手动设置。
- 将 header 里的
- 在 预执行脚本 里引用前面创建公共脚本。
- 将用来验证登录态的参数值设置为
# 公共脚本示例
注意
- 示例脚本里的登录
用户名
和密码
,是从环境变变量LOGIN_USERNAME
和LOGIN_PASSWORD
获取,如果你直接拷贝代码的话,记得要手动设置这两个环境变量。 - 如果你们的 token 没有过期时间,可以将
ACCESS_TOKEN_EXPIRES
相关的代码去除。 - pm.sendrequest 参考文档
- pm.cookies 参考文档
// 定义发送登录接口请求方法
function sendLoginRequest() {
// 获取环境里的 前置URL
const baseUrl = pm.environment.get('BASE_URL');
// 登录用户名,这里从环境变量 LOGIN_USERNAME 获取,也可以写死(但是不建议)
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: {
mode: 'urlencoded',
urlencoded: [
{ key: 'account', value: username },
{ key: 'password', value: password }
]
}
};
// 发送请求。
// 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(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();
// 将 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();
}