Get user

GET {{url}}/users/1235

List users

These requests are meant to mock how call to list a single or multiple users would behave.

Please review the example matching features that are being leveraged.

Commonly used example matching techniques are done by:

  • Filter by HTTP method
  • Filter by headers
    • x-mock-response-code
      • The API call's response code, e.g. 200 OK, 201 Created, etc.
    • x-mock-response-id
      • The UID of the example
    • x-mock-response-name
      • The name of the example
  • Filter by URL
  • Filter by parameter keys and values

Custom Header and Request body matching

Another optional way to filter examples responses is using customer Header and Request body matching. These settings can be optionally configured under your [Mock Server's configuration page]

HEADERS

KeyDatatypeRequiredDescription
x-mock-response-namestring
x-mock-response-namestring
x-mock-response-codestring
x-mock-response-codestring
x-mock-response-idstringGet user (success). Note that this id will be different if you have forked the original collection.
x-mock-response-idstringGet user (not found). Note that this id will be different if you have forked the original collection.

RESPONSES

status: OK

{"userId":"{{userId}}","firstName":"{{$randomFirstName}}","lastName":"{{$randomLastName}}","userActive":"{{$randomBoolean}}"}