API Academy
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
HomePetstore APIExplore more APIs
HomePetstore APIExplore more APIs
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
  1. Working with APIs
  • 歡迎
  • 目錄
  • API 學院
    • Get Started
      • 什麼是 API?
      • API 如何運作?
      • 如何呼叫 API?
      • 如何閱讀 API 文件?
      • 章節總結
    • API Fundamentals
      • API 基礎知識:概覽
      • 方法與路徑
      • 參數
      • 請求 Body
      • 回應
      • API 規格與 OAS
      • 章節總結
    • Working with APIs
      • 使用 API:概覽
      • 根據規格發送請求
      • 環境與變數
      • 串聯多個端點
      • 處理 Auth
      • 處理 API 簽名
      • 腳本介紹
      • 章節總結
    • Mocking APIs
      • Mocking API:概覽
      • Smart Mock
      • Mock 預期結果
      • Cloud Mock
      • Mock 腳本
      • 章節總結
    • Designing APIs
      • 設計 API:概覽
      • API 設計介紹
      • 建立您的第一個 API 專案
      • 分析需求並規劃您的 API
      • 設計資料模型
      • 設計端點
      • 使用組件與可重用性
      • 設定與 Auth
      • API 設計指南
      • 章節總結
    • Developing APIs
      • 開發 API:概覽
      • 設定:安裝您的 AI 程式碼助手
      • 快速入門:30 分鐘內從規格到運行的 API
      • 了解生成的程式碼
      • 使用 Apidog 測試您的 API
      • 部署:將您的 API 上線
      • 章節總結
    • Testing APIs
      • 測試 API:概覽
      • 快速入門:您的第一個測試場景
      • 整合測試與資料傳遞
      • 動態值
      • 斷言與驗證
      • 流程控制:If, For, ForEach
      • 資料驅動測試
      • 性能測試
      • 測試報告與分析
      • CI/CD 整合
      • 排程任務與自動化
      • 進階測試策略
      • 章節總結
    • API Documentations
      • API 文件:概覽
      • 發布您的第一個 API 文件
      • 自訂文件外觀
      • 給消費者的互動功能
      • 進階發布設定
      • 管理 API 版本
      • 章節總結
    • Advanced API Technologies
      • 進階 API 技術:概覽
      • GraphQL
      • gRPC
      • WebSocket
      • Socket.IO
      • Server-Sent Events
      • SOAP
      • 章節總結
    • API Lifecycle
      • API 生命周期:概覽
      • API 生命周期的階段
      • API 治理
      • API 安全最佳實踐
      • 監控與分析
      • API 版本策略
      • API 的未來
      • 章節總結
    • API Security
      • API 安全性:概覽
      • API 安全性基礎知識
      • 身份驗證 vs. 授權
      • 了解 OAuth 2.0 和 OpenID Connect
      • JSON Web Tokens (JWT)
      • OWASP API 安全 Top 10
      • 加密與 HTTPS
      • 章節總結
    • API Tools
      • API 工具:概覽
      • API 工具的演變
      • API Clients
      • 命令列工具 (cURL, HTTPie)
      • API 設計和文件工具
      • API Mocking 工具
      • API 測試工具
      • 一體化 API 平台
      • 章節總結
    • API Gateway
      • API Gateway:概覽
      • 什麼是 API Gateway?
      • API Gateway 的關鍵功能
      • API Gateway vs 負載平衡器 vs 服務網格
      • 流行 API Gateway 解決方案
      • BFF (Backend for Frontend) 模式
      • 章節總結
HomePetstore APIExplore more APIs
HomePetstore APIExplore more APIs
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
🌐 繁體中文
  • 🌐 English
  • 🌐 繁體中文
  1. Working with APIs

腳本介紹

進階功能
腳本 是一項 進階功能,需要 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. 前置處理器腳本#

前置處理器腳本在請求發送 之前 運行。它們適用於:
動態修改請求參數
新增或修改請求標頭
生成簽名或 Token
設定驗證
準備請求資料

範例:新增時間戳標頭#

假設您想在每個請求標頭中新增時間戳:

範例:修改請求 Body#

您也可以在發送之前修改請求 Body:

4. 後置處理器腳本#

後置處理器腳本在接收回應 之後 運行。它們適用於:
驗證回應資料(斷言)
從回應中提取值
將資料儲存在環境變數中
記錄回應資訊

範例:斷言回應狀態#

檢查回應狀態碼是否為 200:

範例:提取並儲存 Token#

從回應中提取 Token 並將其儲存到環境變數中:

範例:驗證回應資料#

檢查回應是否包含預期資料:

5. 如何新增腳本#

向您的請求新增腳本很簡單:

步驟 1:打開前置/後置處理器#

1.
打開專案中的任何端點。
2.
切換到 "Run" 分頁。
3.
向下捲動到 Pre Processors 或 Post Processors 部分。

步驟 2:新增自訂腳本#

1.
點擊 "Add PreProcessor" 或 "Add PostProcessor"。
2.
從下拉選單中選擇 "Custom Script"。
3.
在腳本編輯器中輸入您的 JavaScript 程式碼。

步驟 3:測試您的腳本#

1.
點擊 "Send" 執行請求。
2.
檢查 Console 分頁以查看任何 console.log() 輸出。
3.
驗證您的腳本是否正確執行。

6. 除錯腳本#

您可以使用 console.log() 輸出資訊來除錯您的腳本:
發送請求後,所有控制台輸出都會出現在 Console 分頁中。

7. 常見用例#

以下是腳本很有用的一些常見場景:

用例 1:動態驗證#

在每個請求之前生成 Token 或簽名:

用例 2:條件邏輯#

根據環境變數修改請求:

用例 3:回應驗證#

驗證複雜的回應結構:

8. 關鍵重點#

腳本 是在請求之前(前置處理器)或之後(後置處理器)運行的 JavaScript 程式碼片段。
前置處理器腳本 在發送之前修改請求(例如,新增標頭、修改 Body)。
後置處理器腳本 在接收後處理回應(例如,斷言、提取變數)。
當您需要視覺化處理器無法處理的自訂邏輯時 使用腳本。
使用 console.log() 向 Console 分頁輸出資訊以 除錯腳本。
Apidog 腳本 與 Postman 腳本語法相容。

腳本為您在 API 工作流程中實作自訂邏輯提供了靈活性。雖然視覺化處理器可以處理大多數常見任務,但當您需要更多控制和自訂時,腳本隨時為您服務。
本文提供了 Apidog 中腳本的基本介紹。有關更詳細的用法、進階範例和綜合文件,請參閱 Apidog 官方腳本文件。
現在您已經掌握了腳本,讓我們用 章節總結 來結束本章。
Modified at 2025-12-29 12:07:25
Previous
處理 API 簽名
Next
章節總結
Built with