管理身份验证状态

身份验证是 API 测试和开发中的关键环节。正确管理身份验证状态可确保你的 API 请求安全、高效，并准确反映真实使用场景。

本指南演示如何在 Apidog 中有效处理身份验证状态，涵盖常见的身份验证方法和自动登录实现。

常见身份验证方法

1. Session/Cookie 身份验证

Apidog 会通过 session 和 cookie 自动维护身份验证状态。

工作原理：

执行登录 API 后，Apidog 会全局保存返回的 Session/Cookie 信息

后续 API 调用会自动包含此 Session/Cookie 信息

无需为每个请求进行手动配置

有关如何通过 Session/Cookie 实现自动登录的详细信息，请参阅自动登录实现部分。

2. 基于 Token 的身份验证

基于 Token 的身份验证需要在 API 请求参数中包含登录凭证，通常位于 Header 中。常见方式包括 Basic Auth、Bearer Token 和 API Key。

实现选项：

选项 1：全局配置身份验证

在不同级别设置身份验证信息：

项目级别：项目概览页面

分组级别：分组设置

单个 API 级别：文档页面

支持的身份验证类型：

Basic Auth

Bearer Token

API Key

OAuth 2.0

以及更多

选项 2：手动配置 Token

手动将 token 添加到 Header 或其他相关参数中。我们建议使用环境变量来存储 token。

示例：

Bearer Token：设置一个名为 Authorization 的 Header，其值为 Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9yJpZCI6

使用环境变量：Bearer {{AUTH_TOKEN}}

选项 3：全局参数

在全局参数中设置该值。所有 API 在运行时都会自动包含全局参数，从而无需为每个 API 手动配置。

有关如何通过 token 实现自动登录的详细信息，请参阅自动登录实现部分。

3. 自动登录方法

此方法会自动调用登录 API 来完成身份验证，无需手动干预，并在多个请求之间维持身份验证状态。

自动登录实现

期望结果

无需手动干预即可自动调用登录 API

登录成功后保留身份验证状态，避免重复调用登录 API

凭证过期时进行 Token 刷新

实现步骤

步骤 1：设置环境变量

使用环境变量存储身份验证凭证：

ACCESS_TOKEN：存储登录凭证

ACCESS_TOKEN_EXPIRES：存储过期时间（如适用）

步骤 2：创建公共脚本

该脚本应：

检查 ACCESS_TOKEN 是否有值，以及 ACCESS_TOKEN_EXPIRES 是否仍然有效

如果有效，则继续执行请求

如果无效或缺失，则继续下一步

使用 pm.sendRequest 调用登录 API

将返回的凭证和过期时间写入环境变量

步骤 3：配置需要身份验证的 API

对于每个需要身份验证的 API：

将身份验证参数设置为 {{ACCESS_TOKEN}}

将 Authorization 头部设置为 {{ACCESS_TOKEN}}

或根据需要使用 cookie/其他参数

或者，将该值设置在全局参数中，以便在所有 API 调用中自动包含

在前置处理器脚本中引用公共脚本

公共脚本示例

重要注意事项：

此脚本中的登录凭证来自 LOGIN_USERNAME 和 LOGIN_PASSWORD 环境变量。使用此代码前，请确保已设置这些变量。

如果你的 token 不会过期，请移除与 ACCESS_TOKEN_EXPIRES 相关的代码。

请根据你的具体 API 要求调整登录请求结构和响应处理方式。

其他资源

pm.sendRequest 文档

pm.cookies 文档

管理身份验证状态

常见身份验证方法#

1. Session/Cookie 身份验证#

2. 基于 Token 的身份验证#

选项 1：全局配置身份验证#

选项 2：手动配置 Token#

选项 3：全局参数#

3. 自动登录方法#

自动登录实现#

期望结果#

实现步骤#

公共脚本示例#

其他资源#

常见身份验证方法

1. Session/Cookie 身份验证

2. 基于 Token 的身份验证

选项 1：全局配置身份验证

选项 2：手动配置 Token

选项 3：全局参数

3. 自动登录方法

自动登录实现

期望结果

实现步骤

公共脚本示例

其他资源