Skip to main content

Request

info

Mocktail is still in Beta so if you find any bugs with the app or issues with these docs, please report them on GitHub

Introduction​

Once you have named your endpoint, you will need to fill out some key details about your request.

Request section example

URL​

You can set the URL your endpoint can be requested on (This will be prefixed with http://localhost:3333/api/data/). The full URL can be copied to your clipboard by clicking the clipboard icon button to the right of the URL. This will include any Query Params that have been added (See below)

Url Example

Query params​

Query Params are an optional addition to the endpoint URL. These can be used to pass static values to your response body.

Query param example

You can easily configure Query Params by doing the following:

  1. Click the 'Add Param' button
  2. Type the name of the query param
  3. In the Response Body section, select 'Static Value' from the Node Type dropdown
  4. Give your static field a name
  5. Select Query Param from the Type dropdown
  6. Select the query param from step 2 from the Param Key dropdown

Query Param Static Value example

Request body​

The Request body params can be used to pass static values to your response body.

Request body example

You can easily configure Query Params by doing the following:

  1. Click the 'Add Param' button
  2. Type a param name being passed in the request body
  3. In the Response Body section, select 'Static Value' from the Node Type dropdown
  4. Give your static field a name
  5. Select Request Body from the Type dropdown
  6. Select the param from step 2 from the Param Key dropdown

Request body Static Value example

Request type​

Example of static boolean value

From this dropdown you can set the Request type (default value is GET).

Request Type
DELETE
GET
PATCH
POST
PUT