Install the package as a devDependency:
npm install mockayo --save-dev
Create a JavaScript config file with any name, with the following structure:
module.exports = {
baseDirectory: '[PATH TO YOUR DIRECTORY WITH MOCK SCENARIOS]',
port: [PORT TO RUN THE MOCK SERVER ON], // defaults to 8000,
mocks: [
{
name: '[ENDPOINT NAME - WILL BE DISPLAYED IN CONTROL UI]',
method: '[ENDPOINT METHOD]',
url: '[ENDPOINT URL]',
directory: '[SUBDIRECTORY WITH SCENARIOS (UNDER BASE DIRECTORY)]',
},
// ... define as many mocks as you wish ...
]
};
For each mock (combination of URL and method), create a directory with at least one scenario, called default.js. You can create as many as you want though.
Each scenario should be a regular JavaScript file, exporting an object with the following structure:
module.exports = {
code: [HTTP RESPONSE CODE], // defaults to 200
body: [HTTP RESPONSE BODY - STRING OR JAVASCRIPT OBJECT (NOT SERIALIZED)],
}
Check out an example of the config file and mock scenarios.
Finally, add a command to your package.json:
"scripts": {
// ... your scripts ...
"mock-server": "mockayo [RELATIVE/ABSOLUTE PATH TO YOUR CONFIG FILE]"
},
Now, you can run your mock server, using the following command:
npm run mock-server
When the server is running, you can make all calls you defined in the config, as well as access the control UI to switch scenarios.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent