Mock scripts

Sometimes, you need to return mock data that corresponds to specific request parameters or maintains logical relationships between different properties.

Example

When requesting user info with an ID of 1001, the response includes this ID, and its value should be 1001.

Or, when mock data contains related properties like start and end times, the end time should be later than the start time.

These logical relationships can be implemented using mock scripts.

How it works

The basic implementation principle of mock scripts is as follows:

Use Smart mock or other mock features to generate an initial mock response, which may not meet all the required constraints.

Use mock scripts to access the $$.mockResponse object and/or $$.mockRequest object.

Retrieve data from mockResponse and mockRequest, and write JavaScript to implement the desired logic.

Use the $$.mockResponse.setBody method to rewrite the mockResponse with your modified data.

The mock engine returns the final mockResponse.

Using Mock Scripts

Switch to the Mock tab, where the Mock Script section is located at the bottom.

Turn on the script toggle.

Write your script and save it.

Script reference

Mock script example

This script does the following:

It starts with an initial mock response (generated automatically).

It then modifies this response by:

Setting the page value to match what was requested.

Setting a fixed total value.

Finally, it updates the mock response with these changes.

$$.mockRequest object

The $$.mockRequest object represents the incoming request in your mock script. It's similar to Postman's pm.request object but with some additional features.

getParam(key: string) method: Retrieves parameters from the request, regardless of their location (query string, body, etc.).

Access to cookies: Allows you to retrieve cookie values from the request.

Usage examples

$$.mockResponse object

The $$.mockResponse object represents the response that will be sent back. It's similar to Postman's pm.response object but with additional methods for greater control over the mock response.

setBody(body: any) method: Sets the response body.

setCode(code: number) method: Sets the HTTP status code of the response.

setDelay(duration: number) method: Adds a delay to the mock response, simulating network latency.

Usage examples

FAQ

Q: How to use Apidog variables in mock scripts?
A: Mock scripts cannot use variables. This is because variables are a feature of the Apidog client, but the mock engine is not part of the client, so it cannot reference variables in the client.

Q: How to use log statements in mock scripts to print to the console?
A: Mock scripts do not provide logging functionality. This is because the console is a feature of the Apidog client, but the mock engine is not part of the client, so it cannot output logs to the client.

Q: Why can't I use pm object in mock scripts?
A: Mock scripts are executed on the mock server, while pre and post scripts are executed on the Apidog client that sends the request. These are completely different environments, so the script syntax cannot be shared between them.

How it works#

Using Mock Scripts#

Script reference#

Mock script example#

$$.mockRequest object#

Usage examples#

$$.mockResponse object#

Usage examples#

FAQ#

How it works

Using Mock Scripts

Script reference

Mock script example

$$.mockRequest object

Usage examples

$$.mockResponse object

Usage examples

FAQ