概覽 - Apidog Docs

前置與後置處理器是 Apidog 的關鍵功能。當你傳送請求時，可以使用前置處理器動態控制你的請求，或使用後置處理器處理收到的回應。

Apidog 提供視覺化、拖放式介面，用於請求前與請求後操作，作為傳統腳本式方法的補充。此視覺化介面可讓你無需撰寫程式碼即可設定常見操作，同時仍支援進階使用情境的自訂腳本。

快速開始

以下是在 Apidog 中使用前置與後置處理器的步驟：

開啟任一端點，並前往 Run 分頁（Design-first Mode）或 Request 分頁（Request-first mode）。

Design-first Mode

Request-first Mode

切換到 Pre Processors 或 Post Processors 區段，將游標停留在 + Add 上，並選擇所需的處理器。

填寫新增處理器所需的欄位。

按一下 Send，請求將會使用已設定的前置/後置處理器執行。

在 Design-first Mode 中，按一下 Save as case 以儲存請求。在 Request-first Mode 中，按一下 Save 或 Save as case 以儲存請求。

Design-first Mode

Request-first Mode

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 來簡化腳本撰寫。以自然語言描述你的邏輯，產生器就會為你建立可執行的腳本。

執行順序

前置與後置處理器可在多個層級設定：

Run/Endpoint Case 層級（預設）：僅影響目前的執行/案例。

端點層級：套用至與該端點相關聯的所有案例。

資料夾層級：影響資料夾內的所有端點。

專案層級：套用至專案內的所有請求（最高範圍）。

執行流程會從最高層級（專案/資料夾）向下執行到特定的 Run/Case 層級。

視覺化執行

請求中的一組前置處理器可能如下所示：

在上方螢幕截圖中：

前三個處理器分組在 Inherit from parent 之下。它們定義於 Root 資料夾、特定資料夾（例如「Pets」）或端點本身。

這些繼承的處理器在目前執行中為唯讀，但可以開啟/關閉。

最後一個處理器是專為此次執行新增的自訂腳本，可直接編輯。

變數替換

你可能會注意到一個名為 Variable Substitution & Inherit from Parents 的步驟。這個特殊的前置處理器會將 {{variable}} 這類佔位符替換為其實際值。

預設行為：大多數前置處理器會在變數替換之前執行。

替換後：某些腳本（例如 API 簽章）必須在變數被替換之後執行。你可以手動將這些處理器拖曳到「Variable Substitution」步驟下方。

完整執行流程

單一請求的詳細執行順序如下：

概覽

快速開始#

功能#

前置處理器#

後置處理器#

可用處理器#

執行順序#

視覺化執行#

變數替換#

完整執行流程#

快速開始

功能

前置處理器

後置處理器

可用處理器

執行順序

視覺化執行

變數替換

完整執行流程