腳本 是一項 進階功能,需要 JavaScript 知識。對於大多數用例,Apidog 的視覺化處理器(前置/後置處理器)已足夠。如果您剛開始接觸 API,可以跳過本文。
在上一篇關於 處理 API 簽名 的文章中,我們使用了 前置處理器腳本 來自動生成並將簽名新增到 API 請求中。您可能想知道:這些腳本究竟是什麼,它們是如何運作的?在 Apidog 中,腳本 是 JavaScript 程式碼片段,允許您為 API 請求和回應新增動態行為。雖然 Apidog 為常見任務提供了許多視覺化處理器,但腳本為您提供了實作無法透過視覺化介面實現的自訂邏輯的靈活性。在本文中,我們將介紹在 Apidog 中使用腳本的基礎知識,包括何時使用它們以及讓您入門的簡單範例。
1. 什麼是腳本?#
Apidog 中的 腳本 是在 API 請求生命週期的特定時間點執行的 JavaScript 程式碼片段:Pre-processor scripts (前置處理器腳本):在向伺服器發送請求 之前 運行
Post-processor scripts (後置處理器腳本):在從伺服器接收回應 之後 運行
腳本可以存取和修改請求資料、環境變數和回應資料,使它們成為自訂 API 工作流程的強大工具。
2. 何時使用腳本#
Apidog 為常見任務(如提取變數、新增斷言等)提供了許多視覺化處理器。但是,當您需要以下功能時,腳本很有用:自訂邏輯:視覺化處理器無法處理的複雜計算或條件邏輯
Apidog 腳本語法與 Postman 腳本語法相容。如果您熟悉 Postman 腳本,可以直接在 Apidog 中使用它們。
3. 前置處理器腳本#
前置處理器腳本在請求發送 之前 運行。它們適用於:範例:新增時間戳標頭#
範例:修改請求 Body#
4. 後置處理器腳本#
後置處理器腳本在接收回應 之後 運行。它們適用於:範例:斷言回應狀態#
範例:提取並儲存 Token#
從回應中提取 Token 並將其儲存到環境變數中:範例:驗證回應資料#
5. 如何新增腳本#
步驟 1:打開前置/後置處理器#
3.
向下捲動到 Pre Processors 或 Post Processors 部分。
步驟 2:新增自訂腳本#
1.
點擊 "Add PreProcessor" 或 "Add PostProcessor"。
2.
從 下拉選單中選擇 "Custom Script"。
3.
在腳本編輯器中輸入您的 JavaScript 程式碼。
步驟 3:測試您的腳本#
2.
檢查 Console 分頁以查看任何 console.log() 輸出。
6. 除錯腳本#
您可以使用 console.log() 輸出資訊來除錯您的腳本:發送請求後,所有控制台輸出都會出現在 Console 分頁中。
7. 常見用例#
用例 1:動態驗證#
用例 2:條件邏輯#
用例 3:回應驗證#
8. 關鍵重點#
腳本 是在請求之前(前置處理器)或之後(後置處理器)運行的 JavaScript 程式碼片段。
前置處理器腳本 在發送之前修改請求(例如,新增標頭、修改 Body)。
後置處理器腳本 在接收後處理回應(例如,斷言、提取變數)。
當您需要視覺化處理器無法處理的自訂邏輯時 使用腳本。
使用 console.log() 向 Console 分頁輸出資訊以 除錯腳本。
Apidog 腳本 與 Postman 腳本語法相容。
腳本為您在 API 工作流程中實作自訂邏輯提供了靈活性。雖然視覺化處理器可以處理大多數常見任務,但當您需要更多控制和自訂時,腳本隨時為您服務。現在您已經掌握了腳本,讓我們用 章節總結 來結束本章。