Build and Push to npm registry

Change the application version in package.json and build + push to npm repo

npm login

npm run build

npm push

instant-mock

instant-mock is a quick and easy web API mock server.

Installing globally

Installation via npm:

1npm install -g instant-mock

Usage

1mkdir mymock
2cd mymock
3instant-mock init
4instant-mock

You can open http://localhost:3000 to view the instant-mock web console.

All mock API is mounted on http://localhost:3000/mock. Please try GET to http://localhost:3000/mock/users by curl or web browser. It is sample mock API created by instant-mock init.

Configuration

Servce configuration is wrote on server.yml

1http:
2  host: localhost
3  port: 3000
4
5socket:
6  host: localhost
7  port: 3010

Creating your mocks

API definition

You can create mock definition file to mock directory. Mock API URL is auto generated by directory path. mock/api-name/@METHOD is mapped to METHOD: http://localhost:3000/mock/api-name METHOD can use get/post/put/patch/delete.

If you need route parameters, can use PARAM directory. mock/api-name/$id/@get is mapped to GET: http://localhost:3000/mock/api-name/:id

Request parser

Request for mock is parsed by user definition parser file. User definition parser file name start with "parser-" and format is yaml or js.

Try create a parser file below, and access to http://localhost:3000/mock/books after restart the instant-mock.

/mock/books/@get/parser-default.yml:

1status: 200                   # Response status code.
2headers:                      # Response headers.
3  Content-Type: application/text
4rawBody: 'test body'          # Response body.

Define the response body to other file

You can define response body to a any file.

./mock/books/@get/body.json:

1{
2  "key": "value"
3}

./mock/books/@get/parser-default.yml:

1status: 200
2headers:
3  Content-Type: application/json
4body: 'body.json'    # Response body file.

Change a reponse by request

Parser file can define multiple resonse for switing by request. Define request parsing rule to if, and response to then.

Try create a parser file below, and access to http://localhost:3000/mock/books/:id after restart the instant-mock. If :id is "1" then response body is "user 1", and if it is "3" then response is 404.

./mock/books/$id/@get/parser-default.yml:

1- if:
2    params:
3      id: 1
4  then:
5    rawBody: 'book 1'
6
7- if:
8    params:
9      id: 2
10  then:
11    rawBody: 'book 2'
12
13- then:
14    status: 404

if is can use params/query/body, and it is "and" condition.

• params: Route parameter.
• query: Query string parameter.
• body: Parsed json body parameter.

Advanced parser

YAML format parser is support simple rule only. Use a js parser if you need more advanced rules.

./mock/shelves/:id/@get/parser-default.js:

1exports.default = function (req) {
2  return {
3    status: 200,
4    headers: {
5      'content-type': 'application/text',
6    },
7    rawBody: 'your book is ' + req.params.id,
8  };
9};

Web console

You can open http://localhost:3000 to view the instant-mock web console. Web console can change parser, and show mock api access logs.

Publishing a new version to npm repo

Modify the app version in package.json

Run the command `npm run build`

npm login

npm publish