使用变量

在 Apidog 中，变量允许你轻松保存并复用值。将某个值存储为变量后，你就可以在各种环境、请求、脚本和测试场景中访问它。使用变量可以提高工作效率，并促进同事之间的团队协作。

什么是变量？

变量是数据的符号化表示，它允许你在需要时检索某个值，而无需每次手动输入。这有利于在不同位置复用相同的值。

示例：
如果你在多个请求中使用相同的 token，并预计它可能会发生变化，请将该 token 保存为名为 {{my_token}} 的变量。在请求参数值中使用 {{my_token}}。当 token 发生变化时，更新变量值即可在所有位置同步更新。

变量可以在参数值、主体、URL 或头部中生效。

在 Apidog 的 Tests 模块中，变量可用于在请求之间传递数据。

变量作用域

Apidog 支持多种作用域的变量，以适应不同的开发、测试和协作需求。

优先级（从低到高）：全局 < 模块 < 环境 < 数据 < 本地

当同名变量在不同作用域中定义时，最窄作用域中的值优先。

全局变量

项目内共享：可在整个项目中访问。适用于在端点之间共享数据（例如登录 token）。

团队内共享：在整个团队的不同项目之间共享（例如登录项目和财务项目之间共享的 token）。

NOTE

权限：要管理团队变量，你需要团队管理员权限。前往 Team Resources > Variables。

脚本：你可以使用 pm.globals.set 在脚本中更新本地值，但不能更改名称或共享值。

模块变量

在模块内定义。从 Postman 导入的 “Collection variables” 会映射为模块变量。

环境变量

绑定到特定环境（开发、测试、生产）。只有当前激活环境中的变量会生效。

数据变量

来自 Test Scenarios 或 CLI 中的外部 CSV 或 JSON 文件。运行结束后，值不会持久保留。

本地变量

限定在单个请求或测试场景运行中的临时变量。完成后即消失。

TIP

Apidog 中的变量以字符串形式存储。保存对象或数组时，请使用 JSON.stringify() 存储，并使用 JSON.parse() 取回。

共享值和本地值

每个变量都有两种状态：

共享值：与 Apidog 服务器同步，并与团队共享。

本地值：本地存储在你的浏览器或客户端缓存中。不会共享。

最佳实践：

对敏感数据（token、密码）使用本地值，使其仅保留在你的设备上。

将本地值留空，以回退使用共享值。

点击链接图标 🔗，将本地值与共享值同步。

WARNING

清理 Apidog 缓存会删除本地值。

切换设备时，本地值不会自动迁移（请使用环境导出/导入）。

在 Apidog CLI 中使用变量

在 CLI 中运行时，默认使用共享值；而客户端使用本地值。这是客户端运行和 CLI 运行之间出现差异的常见原因。

TIP

了解更多关于 Apidog CLI 的信息。

定义变量

1. 环境管理（预设）

全局变量和环境变量的值可以手动预设。

点击 Environment Management 图标 ≡。

选择 Global Variables 或某个具体环境。

添加变量名称、共享值和本地值。

点击 Save。

2. 提取变量

无需编写代码，即可从 API 响应中以可视化方式提取值并保存为变量。

在 Run 标签页（设计模式）中，前往 Post Processors。

选择 Extract Variable。

配置提取来源（JSON、XML、Header 等）和 JSONPath。

发送请求以执行，并在 Console 中验证。

TIP

了解更多关于 Extract Variable 的信息。

3. 脚本

在前置/后置处理器中使用 pm 对象。

set 的语法：

存储对象/数组：

TIP

了解更多关于 Script Syntax 的信息。

4. 数据库操作

连接到数据库以检索数据，并将其设置为变量。

在后置处理器中添加 Database Operation。

配置数据库连接。

输入 SQL 命令（支持 {{variable}}）。

设置 Extract Result To Variable。

TIP

了解更多关于 Database Operations 的信息。

请求参数

在 URL、参数、头部或主体中使用双花括号 {{variable}}。

示例 URL：
http://127.0.0.1/pet/findByStatus?status={{CurrentStatus}}

示例 JSON 主体：

{
    "status": "{{CurrentStatus}}",
    "quantity": {{TotalPet}}
}

WARNING

字符串：对于字符串，请在变量外添加双引号 ""（例如 "{{name}}"）。

数字/布尔值：不要添加引号（例如 {{count}}）。

访问子元素

如果变量包含 JSON 对象/数组，请使用 JSONPath 通过点表示法访问属性。

{{user}} 中的对象：

{ "id": 1, "name": "Jack" }

请求：{{user.name}}

脚本：pm.variables.get("user.name")

{{users}} 中的数组：

[ { "name": "Jack" } ]

请求：{{users[0].name}}

脚本：pm.variables.get("users[0].name")

在脚本中使用变量

在脚本中，请使用 pm.*.get()，而不是 {{}}。

日志记录：

查看 Console 标签页以查看输出。

使用数据变量

在 Test Scenarios 中，导入 CSV/JSON 文件会创建“数据变量”。使用 {{column_name}} 引用它们。文件中的每一行都会触发一次单独的迭代。

TIP

了解更多关于 Data Driven Testing 的信息。

FAQ

问：我可以在 Mocks 中使用变量吗？

不可以。 变量会在请求发送时被解析。Mocks 是静态定义，或在模拟服务器上运行，并不以相同方式具备客户端侧的“发送”上下文。

问：如何在脚本中获取 base URL？

使用 pm.request.getBaseUrl()。

避免使用 pm.environment.get('BASE_URL')，因为对于非默认服务器端点，它可能不准确。

使用变量

什么是变量？#

变量作用域#

共享值和本地值#

在 Apidog CLI 中使用变量#

定义变量#

1. 环境管理（预设）#

2. 提取变量#

3. 脚本#

4. 数据库操作#

使用变量#

请求参数#

访问子元素#

在脚本中使用变量#

使用数据变量#

FAQ#

什么是变量？

变量作用域

共享值和本地值

在 Apidog CLI 中使用变量

定义变量

1. 环境管理（预设）

2. 提取变量

3. 脚本

4. 数据库操作

使用变量

请求参数

访问子元素

在脚本中使用变量

使用数据变量

FAQ