imock-tool

imock

Mock Backend Server

Quick Start

Install Module globally

$ npm install -g imock-tool

Intital Project

$ mkdir job && cd job
$ imock init

or

$ imock init job

Start Up Server

$ imock 

Use As A NodeModule?

var imock = require('imock-tool')
var app = imock({
    
},callback)

callback

Allow custom callback function after express server listened, default callback will be used if callback is not specified.

Routes

Routes is stored in route.js as key/value pairs by default.

Sample:

module.exports = {
    // set json api with a json/js file in mock folder
    'POST::/test':         'mock::test.js',
 
    //simple proxy
    'GET::/api'  :         'https://domain.com/api'
}

the rule is '[method]::[route_url]': '[template_file]'.

Allowed method: GET, POST, PUT, PATCH, DETELE

GET will be used if it is not specified.

Response Body

module.exports = {
    '$$statusCode':404,
    '$$delay':3000,
    '$$header':{
        'Content-Type':'application/json'
    },
    'message':'hello world'
}
 

$$statusCode

deafult: 200

The http response status

$$delay

default: 0

The http response delay

$$header

The http response header

Configuration

basePath

The base path of the project, all other folder settings are related to base path.

mockFolder

default: 'mocks'

Save you mock data into this folder.

routeFile

default: 'route.js'

Routes mapping file

port

default: 3000

Express server port

proxy

deafult: null

How to use proxy ?

middlewares

default: null

livereload

default: true

livereload is awesome, it will restart your server automatically after anything of mockFolder changed.