Advanced Mock

View details for advanced mock here.

Mock Priority

Mock rule priority: Expectations in Advanced Mock > Custom Mock Scripts.

The custom Mock script is not called if the Advanced Mock expectation is met.

Mock Expectation

Configuration:

1. Expectation: Depending on the request parameters, different data is returned. For example, you can create two expectations:
   • Returns the sales status of available if the request parameter id is 1.
   • Returns the sales status of sold if the request parameter id is 2.
2. The expectation condition supports multiple parameters. The expectation will only be matched when all parameters are matched at the same time.
3. Expectations condition supports comparison relationships between parameter name and parameter value, including equal to, less than, greater than, exist, belong to, etc.
4. The actual request body must match the API definition if the body is chosen as the parameter location for expectation criteria. If the body request type is form-data in API definition, the parameter needs to be placed in form-data when mocking.
5. Expectation Rule: We support JSON Path matching for JSON body types.
   • We use JSON Path to match parameter names that start with the “\$”.
   • We use JSON first-level attribute names to match parameter names that do not start with “\$”.
6. Return data: We support Faker.js and Nunjucks for data returned from the API request. We support returning dynamic data based on certain rules. For example:

{
     "data": {
         "name": "data returned from advanced mock",
         "mockJs": [
             "@cname",
             "@integer(0,100)",
             "@image(80x90)"
         ],
         "nunjucks": [
          {% for i in range(0, 3) -%}
          {
              "id": "{{i}}",
              "name": "@cname",
              "friends": [
                  {% for item in ['apple','banana','cat', 'dog'] -%}
                  "{{item}}",
                  {%- endfor %}
             ]
          },
          {%- endfor %}
         ]
     },
     "success": true
 }

generated data:

{
  "data": {
    "name": "data returned from advanced mock",
    "mockJs": ["Meryl Niki", 98, "http://dummyimage.com/80x90"],
    "nunjucks": [
      {
        "id": "0",
        "name": "Jeanie Lynsey",
        "friends": ["apple", "banana", "cat", "dog"]
      },
      {
        "id": "1",
        "name": "Jada Annalise",
        "friends": ["apple", "banana", "cat", "dog"]
      },
      {
        "id": "2",
        "name": "Gillian Sandy",
        "friends": ["apple", "banana", "cat", "dog"]
      }
    ]
  },
  "success": true
}

7. We support custom return Header, return HTTP status code, delayed response.

Mock Custom Scripts

We support using custom scripting to get the parameters from user requests and modify the return content.

You can use custom scripts to get parameters for user requests and modify the return message.

Please be aware that custom scripts can only be used in advanced mock, not in preprocessor and postprocessor scripts.

How to Use Custom Scripts

1. Turn on Advanced Mock
2. Use Javascript to modify returned JSON (as shown in the screenshot below).

Example 1

Set paged data

// Get mock data from Smart Mock
var responseJson = $$.mockResponse.json();

// Modify the paged data from responseJson
// Set page as the page in request parameter
responseJson.page = parseInt($$.mockRequest.getParam("page"));
// Set total as 120
responseJson.total = 120;

// Write the modified json into $$.mockResponse
$$.mockResponse.setBody(responseJson);

Example 2

var MockJs = require("mockjs");

// Get JSON from Smart Mock
var responseJson = $$.mockResponse.json();

// Modify response value based on request parameters (including query, body, and path)
if ($$.mockRequest.getParam("id") === "123") {
  responseJson.data = null;
  responseJson.code = 400104;
  responseJson.errorMessage = "data not exists";
  $$.mockResponse.setBody(responseJson);
  $$.mockResponse.setCode(404);
}

// Modify response value based on header
if (!$$.mockRequest.headers.get("token")) {
  responseJson.data = null;
  responseJson.code = 400103;
  responseJson.errorMessage = "No permission";
  $$.mockResponse.setBody(responseJson);
  $$.mockResponse.setCode(403);
}

// Modify response value based on cooked
if ($$.mockRequest.cookies.get("projectId") === "123") {
  var idList = [1, 2, 3, 4, 5, 6, 7, 8];
  $$.mockResponse.setBody({
    code: 0,
    data: idList.map(function(id) {
      return {
        id: id,
        name: MockJs.mock("@cname"),
        email: MockJs.mock("@email"),
        city: MockJs.mock("@city"),
      };
    }),
  });
}

// Set delay for response
$$.mockResponse.setDelay(500);

// Add header
$$.mockResponse.headers.add({
  key: "X-Token",
  value: "<token>",
});

// Add or modify header
$$.mockResponse.headers.upsert({
  key: "X-Token",
  value: "<token>",
});

Request: $$.mockRequest

• $$.mockRequest.headers: Mock request headers.
• $$.mockRequest.cookies: Mock request cookies.
• $$.mockRequest.getParam(key: string): Get mock request parameters, including path, body, and query parameters.

Response: $$.mockResponse

• $$.mockResponse.headers: Mock response header
• $$.mockResponse.code: HTTP code generated by the system
• $$.mockResponse.json(): JSON response generated by the system
• $$.mockResponse.setBody(body: any): Set body for mock response (we support JSON or string).
• $$.mockResponse.setCode(code: number): set HTTP code return by the mock response.
• $$.mockResponse.setDelay(duration: number): set delay (in ms) for mock response.