概述 - Apidog Docs

前置和后置处理器是 Apidog 中的一项关键功能。当你发送请求时，可以使用前置处理器动态控制你的请求，或使用后置处理器处理收到的响应。

Apidog 为请求前和请求后的操作提供了可视化的拖放界面，作为传统基于脚本方法的补充。该可视化界面允许你无需编写代码即可配置常见操作，同时仍支持自定义脚本以满足高级使用场景。

快速开始

以下是在 Apidog 中使用前置和后置处理器的步骤：

打开任意端点并导航到 Run 标签页（设计优先模式）或 Request 标签页（请求优先模式）。

设计优先模式

请求优先模式

切换到 Pre Processors 或 Post Processors 部分，将鼠标悬停在 + Add 上，然后选择所需的处理器。

为添加的处理器填写必要字段。

点击 Send，请求将使用已配置的前置/后置处理器执行。

在设计优先模式中，点击 Save as case 保存请求。在请求优先模式中，点击 Save 或 Save as case 保存请求。

设计优先模式

请求优先模式

TIP

你也可以创建一个独立请求，并为其应用前置/后置处理器。不过，我们建议基于端点规范使用前置/后置处理器，以便让调试和测试更加顺畅。

功能

前置和后置处理器可以共同实现各种功能：

前置处理器

请求参数设置：动态定义 API 端点的输入数据。

头部配置：指定 Content-Type、Accept 和 Authorization 等头部。

身份验证：为受保护的端点添加令牌、API 密钥或凭据。

数据库集成：从数据库中检索值，以用作请求参数。

加密：在传输前保护请求负载。

后置处理器

断言：根据预期结果（状态码、主体内容等）验证收到的响应。

变量提取：从响应中提取值，以用于后续请求。

数据库操作：将响应数据写入数据库以进行存储或更新。

数据可视化：生成响应数据的报告或可视化表示。

TIP

某些前置和后置操作在访问数据库、调用外部程序或动态加载 npm 包时，可能会触发安全授权提示。你可以导航到 Security 设置，预先配置这些授权的范围。

可用处理器

Apidog 支持以下前置/后置处理器：

处理器	类型	描述
Assertion	后置	定义验证规则，用于根据预期值检查响应数据（状态码、主体、头部）。
Extract Variable	后置	从响应（JSON、XML、Text）中提取值，并使用 JSONPath 或 XPath 将其存储为变量。
Database Operation	前置/后置	连接到 SQL/NoSQL 数据库以执行查询。结果可以存储为变量。
Custom Scripts	前置/后置	编写自定义 JavaScript 代码来处理复杂逻辑。访问请求/响应数据和环境变量。
Public Scripts	前置/后置	创建可在多个处理器或场景之间共享的可复用脚本片段。
Wait	前置/后置	在请求之前或之后引入延迟，适用于模拟真实世界的延迟。

我们建议使用 Apidog Script Generator 来简化脚本编写。用自然语言描述你的逻辑，生成器将为你创建可运行的脚本。

执行顺序

前置和后置处理器可以在多个层级进行配置：

运行/端点用例层级（默认）：仅影响当前运行/用例。

端点层级：适用于与该端点关联的所有用例。

文件夹层级：影响该文件夹内的所有端点。

项目层级：适用于项目内的所有请求（最高作用域）。

执行流程从最高层级（项目/文件夹）向下到具体的运行/用例层级。

可视化执行

请求中的一组前置处理器可能如下所示：

在上面的截图中：

前三个处理器分组在 Inherit from parent 下。它们定义在根文件夹、特定文件夹（例如，“Pets”）或端点本身中。

这些继承的处理器在当前运行中为只读，但可以开启/关闭。

最后一个处理器是专门为此次运行添加的自定义脚本，可以直接编辑。

变量替换

你可能会注意到一个名为 Variable Substitution & Inherit from Parents 的步骤。这个特殊的前置处理器会将 {{variable}} 这样的占位符替换为其实际值。

默认行为：大多数前置处理器会在变量替换之前执行。

替换后：某些脚本（例如 API 签名）必须在变量被替换之后运行。你可以手动将这些处理器拖动到 “Variable Substitution” 步骤下方。

完整执行流程

单个请求的详细执行顺序如下：

概述

快速开始#

功能#

前置处理器#

后置处理器#

可用处理器#

执行顺序#

可视化执行#

变量替换#

完整执行流程#

快速开始

功能

前置处理器

后置处理器

可用处理器

执行顺序

可视化执行

变量替换

完整执行流程