登录态（Auth）如何处理

常见处理方式

一、Session/Cookie 方式

Apifox 支持通过 Session/Cookie 自动保持登录态。

使用步骤：

在项目中运行登录接口，接口运行完成后，返回的 Session/Cookie 信息会自动保存到全局 Cookie 中。

后续运行其他接口时，无需额外设置，系统会自动携带相关的 Session/Cookie 信息。

二、Token 方式

Token 方式通过在接口请求中传递凭证实现身份验证，凭证通常放置在 Header 中。常见类型包括 Basic Auth、Bearer Token 和 API Key 等。

使用步骤：

示例：提取响应 token 并存储为环境变量

假设一个登录接口的响应如下：

{
  "status": "success",
  "data": {
    "user": {
      "id": 12345,
      "name": "John Doe"
    },
    "token": "abc123xyz"
  }
}

现在需要从 data.token 提取 token 值。

在登录接口的后置操作的 “自定义脚本” 中编写以下代码：

发送请求后，该脚本会自动执行，token 将被提取并存储到环境变量中，该变量{{token}}可用于后续请求。

提取这个 token 到环境变量还有更简单的方法，就是在 “后置操作” 中新增一个 “提取变量” 的操作，然后通过 JSONPath 表达式的方式来提取。发送请求后，该操作会自动执行。

引用 token

token 存储到环境变量中后，就可以在接口中引用了，有以下几种引用方式：

在全局参数中引用

通过页面右上角环境管理里的 全局参数 进行引用，这样项目中所有接口在运行时都会自动携带该参数：

在目录层级或接口层级中引用

在项目根目录、子目录或接口级别的 Auth 设置中，配置授权信息。支持多种授权类型，如下图所示：

在接口的 Header 中引用

直接将 token 写入 Header 或对应参数中，例如在 Header 中添加 Authorization 字段，值设置为 Bearer {{token}}。

发送请求

发送一个请求，然后在响应控制台的 “实际请求” 中查看是否携带上了环境变量中的{{token}}，如果有，说明 token 引用成功。

三、全自动登录

全自动登录方式可在运行接口用例时自动完成登录，并保持登录态，无需手动操作。

全自动登录实现方式

期望效果

在运行接口用例时自动完成登录。

登录一次后，保存登录态，避免每次运行用例都调用登录接口。

实现思路

保存凭证

使用环境变量 （如 ACCESS_TOKEN） 存储登录凭证；如果凭证有过期时间，可用额外的环境变量 （如 ACCESS_TOKEN_EXPIRES） 记录过期时间。

公共脚本

创建一个公共脚本，实现以下逻辑：

检查 ACCESS_TOKEN 是否存在以及是否过期。

如果 Token 不存在或已过期，调用登录接口，更新环境变量。

接口配置

在需要登录态的接口中引用 {{ACCESS_TOKEN}} 变量。例如，将 Header 中的 Authorization 设置为 {{ACCESS_TOKEN}}。

可选择在环境的全局参数中统一配置，适用于所有接口。

前置脚本调用

在接口用例的前置脚本中调用公共脚本，确保 Token 有效。

公共脚本示例

注意事项：

示例中的用户名和密码从环境变量( LOGIN_USERNAME 和 LOGIN_PASSWORD )中获取，请确保这些变量已正确设置。

如果 Token 无过期时间，可移除与 ACCESS_TOKEN_EXPIRES 相关的代码。

登录接口的请求参数需根据实际需求修改。

参考文档：

pm.sendRequest 文档

pm.cookies 文档

常见处理方式#

一、Session/Cookie 方式#

二、Token 方式#

三、全自动登录#

全自动登录实现方式#

期望效果#

实现思路#

公共脚本示例#