Mock Scripts

Mock scripts enable you to create intelligent mock responses with logical relationships between request parameters and response data. This feature is essential when you need mock data that maintains contextual accuracy or reflects request values.

Use Cases

Mock scripts are ideal for scenarios requiring logical data relationships:

Common Examples

Returning a user ID in the response that matches the requested ID (e.g., request ID 1001 → response includes ID 1001)

Ensuring temporal consistency (e.g., end time is always after start time)

Calculating related fields (e.g., total price based on quantity and unit price)

Reflecting request parameters in the response payload

How Mock Scripts Work

Mock scripts process data through a five-step workflow:

Smart mock or other mock features generate an initial response

Mock script accesses the $$.mockResponse and $$.mockRequest objects

JavaScript logic retrieves and processes data from these objects

The $$.mockResponse.setBody method updates the response with modified data

Mock engine returns the final processed response

Mock scripts only work with Smart mock. They do not apply to mock expectations or response examples.

Using Mock Scripts

Enabling and Writing Scripts

Navigate to the Mock tab where the Mock Script section appears at the bottom

Toggle on the script switch

Write your script in the editor and save

Script Reference

Basic Example

What this script does:

Retrieves the initial automatically generated mock response

Modifies the response by:

Setting page to match the requested page parameter

Setting a fixed total value of 120

Updates the mock response with these changes

$$.mockRequest Object

The $$.mockRequest object represents the incoming request. It's similar to Postman's pm.request object with additional features.

Key Methods:

Method/Property	Description
`getParam(key)`	Retrieves parameters from any location (query, body, etc.)
`headers`	Access HTTP headers
`cookies`	Access cookie values
`body`	Access request body
`formdata`	Access form-data parameters
`urlencoded`	Access URL-encoded parameters

Usage Examples:

$$.mockResponse Object

The $$.mockResponse object represents the response being sent back. It's similar to Postman's pm.response object with additional control methods.

Key Methods:

Method	Parameters	Description
`setBody(body)`	any	Sets the response body
`setCode(code)`	number	Sets HTTP status code
`setDelay(duration)`	number (ms)	Adds response delay (simulates latency)
`json()`	-	Retrieves response as JSON
`headers`	-	Access/modify response headers

Usage Examples:

FAQ

Q: How to use Apidog variables in mock scripts?

A: Mock scripts cannot use Apidog variables.

Variables are a feature of the Apidog client, but the mock engine runs independently and cannot access client-side variables.

Q: How to use log statements in mock scripts?

A: Mock scripts do not provide logging functionality.

The console is a client-side feature, but the mock engine operates separately and cannot output logs to the client console.

Q: Why can't I use the pm object in mock scripts?

A: The pm object is not available in mock scripts.

Mock scripts execute on the mock server, while pre/post scripts execute on the Apidog client. These are completely different execution environments with different available objects and syntax.

Q: Do mock scripts work with mock expectations?

A: No, mock scripts only work with Smart mock.

When a mock expectation is matched, the mock script will not execute. Mock scripts do not apply to mock expectations or response examples.

Use Cases#

How Mock Scripts Work#

Using Mock Scripts#

Enabling and Writing Scripts#

Script Reference#

Basic Example#

$$.mockRequest Object#

$$.mockResponse Object#

FAQ#

Use Cases

How Mock Scripts Work

Using Mock Scripts

Enabling and Writing Scripts

Script Reference

Basic Example

$$.mockRequest Object

$$.mockResponse Object

FAQ