Homebrew: brew install --cask mockoon.

At the first launch, you will have a default setup, the demo API, also called an environment in Mockoon.

Learn how to create partial mocks of existing APIs with Mockoon's proxy mode in three easy steps Read more

Welcome to Mockoon's mock API samples repository. You will find in the apis folder many mock samples from popular APIs (Open Weather, Giphy, etc.).

Mockoon is the easiest and quickest way to run mock REST API servers. No remote deployment, no account required, free, open source and cross-platform.

On the main GET /users route, you can use query parameters to sort, paginate, and filter the list of users. Here are some examples:

Create your mock API server in no time with Mockoon's ready to use mock samples for you favorite APIs: 1Password, BitBucket, GitHub and more

This documentation covers Mockoon's most used features and options to help you create the best mock APIs.

Mockoon implements Handlebars, Faker.js v9.9.0, and a set of custom helpers to create dynamic responses. This templating system is supported in the data buckets, response's body, header, file content, file path and rule. You will find below a global overview of how and where you can use helpers. You can also check the available helpers on specific documentation pages. All the helpers must be used according to Handlebars' syntax, for example: {{helperName param1 param2}}. Some helpers accepting options objects can be used with Handlebars' object params: {{faker 'date.month' abbr=false}}.

Learn how to start working with Mockoon and create mock APIs in no time by making the most out of its features.

All dates use the ISO 8601 format: YYYY-MM-DD For example: 2017-07-01 (the 1st of July 2017) All timestamps use the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ For example: 2017-07-01T11:05:06+10:00 Timezones Some requests allow for specifying timestamps ...

When running your mock API using the CLI, you can disable routes using the --disable-routes flag followed by a route UUID or keyword/name or a folder keyword/name: mockoon start -d ./data.json --disable-routes myroute folder2.

You can now test your setup by calling your mock API with and without an Authorization header. You should see the 401 response when the header is missing and the 200 response when it is present. Here are two examples using curl:

It is useful when you want to run a mock server while running integration tests on another application. For example, you could mock an API when running a React front-end application test.

Integrate with "Data API" from clever.com in no time with Mockoon's ready to use mock sample

As Mockoon is based on JavaScript, the body will be converted into a JSON object internally, which you can manipulate as you would any JSON object using dot notation or array notation. Example URL with query parameters: Copy · http://localhost:3000/route?param1=test&param2=test2&array[]=value1&array[]=value2&obj[prop1]=value // alternative array syntaxes array[0]=value1&array[1]=value2 array=value1,value2 ·

For example, you may want to check that all your requests contain an Authorization header or that they all contain a specific property in their body. In mockoon, you can easily create routes that will apply rules to all your endpoints and server ...

The way the tool serves the responses ... or edge cases. For example, you may want to test errors (403, 404, etc.), or serve different responses depending on the presence of headers or request's body....

Integrate with "API v1.0.0" from envoice.in in no time with Mockoon's ready to use mock sample

In addition to Handlebars' built-in helpers (if, each, etc., for more information, please have a look at Handlebars' documentation), Mockoon offers the following helpers: Repeat the block content a random number of times if two arguments are provided, or a fixed amount of time if only one argument is provided. Set the comma parameter to false (default to true) to prevent the insertion of new lines and commas by the helper. Examples ·