模擬腳本

模擬腳本可讓你建立智慧型模擬回應，並在請求參數與回應資料之間建立邏輯關係。當你需要維持上下文準確性或反映請求值的模擬資料時，此功能非常重要。

使用案例

模擬腳本非常適合需要邏輯資料關係的情境：

常見範例

在回應中回傳與請求 ID 相符的使用者 ID（例如，請求 ID 1001 → 回應包含 ID 1001）

確保時間一致性（例如，結束時間一律晚於開始時間）

計算相關欄位（例如，根據數量和單價計算總價）

在回應承載中反映請求參數

模擬腳本的運作方式

模擬腳本透過五步驟工作流程處理資料：

Smart mock 或其他模擬功能產生初始回應

模擬腳本存取 $$.mockResponse 和 $$.mockRequest 物件

JavaScript 邏輯會從這些物件擷取並處理資料

$$.mockResponse.setBody 方法會使用修改後的資料更新回應

模擬引擎回傳最終處理後的回應

模擬腳本僅適用於 Smart mock。它們不適用於模擬預期或回應範例。

使用模擬腳本

啟用並撰寫腳本

前往 Mock 分頁，Mock Script 區段會顯示在底部

開啟腳本開關

在編輯器中撰寫你的腳本並儲存

腳本參考

基本範例

此腳本的作用：

擷取初始自動產生的模擬回應

透過以下方式修改回應：

將 page 設定為符合請求的頁面參數

將 total 設定為固定值 120

使用這些變更更新模擬回應

$$.mockRequest 物件

$$.mockRequest 物件代表傳入的請求。它類似於 Postman 的 pm.request 物件，並具有其他功能。

主要方法：

方法/屬性	描述
`getParam(key)`	從任何位置（query、body 等）擷取參數
`headers`	存取 HTTP 標頭
`cookies`	存取 cookie 值
`body`	存取請求主體
`formdata`	存取 form-data 參數
`urlencoded`	存取 URL-encoded 參數

使用範例：

$$.mockResponse 物件

$$.mockResponse 物件代表即將送回的回應。它類似於 Postman 的 pm.response 物件，並具有其他控制方法。

主要方法：

方法	參數	描述
`setBody(body)`	any	設定回應主體
`setCode(code)`	number	設定 HTTP 狀態碼
`setDelay(duration)`	number (ms)	新增回應延遲（模擬延遲）
`json()`	-	以 JSON 擷取回應
`headers`	-	存取/修改回應標頭

使用範例：

FAQ

問：如何在模擬腳本中使用 Apidog 變數？

答：模擬腳本無法使用 Apidog 變數。

變數是 Apidog 用戶端的功能，但模擬引擎會獨立執行，無法存取用戶端變數。

問：如何在模擬腳本中使用記錄語句？

答：模擬腳本不提供記錄功能。

主控台是用戶端功能，但模擬引擎會分開運作，無法將日誌輸出到用戶端主控台。

問：為什麼我不能在模擬腳本中使用 pm 物件？

答： pm 物件無法在模擬腳本中使用。

模擬腳本在模擬伺服器上執行，而前置/後置腳本在 Apidog 用戶端上執行。它們是完全不同的執行環境，具有不同的可用物件和語法。

問：模擬腳本是否適用於模擬預期？

答：不適用，模擬腳本僅適用於 Smart mock。

當符合某個模擬預期時，模擬腳本不會執行。模擬腳本不適用於模擬預期或回應範例。

使用案例#

模擬腳本的運作方式#

使用模擬腳本#

啟用並撰寫腳本#

腳本參考#

基本範例#

$$.mockRequest 物件#

$$.mockResponse 物件#

FAQ#

使用案例

模擬腳本的運作方式

使用模擬腳本

啟用並撰寫腳本

腳本參考

基本範例

$$.mockRequest 物件

$$.mockResponse 物件

FAQ