MockRestfulServer

mock-restful-server

A lightweight restful api mock server using models.

• Features
• API
• Usage
  • LIB mode
  • CLI mode
• License

Features

• Models management
• CRUD operations

API

Server infos

• Model structure infos GET http://{address}:{port}

CRUD

• Get collection records GET http://{address}:{port}/{collection}
• Get collection record GET http://{address}:{port}/{id}
• Create collection record POST http://{address}:{port}/
• Update collection record PUT http://{address}:{port}/{id}
• Delete collection record DELETE http://{address}:{port}/{collection}/{id}

Authentication

• Signup POST http://{address}:{port}/signup
• Login POST http://{address}:{port}/login

*Note: /login and /signup routes are reserved for authentication related mocking.

Maintenance

• Generate a whole random database according to the models POST http://{address}:{port}/_randomize
• Dump the current database POST http://{address}:{port}/_dump

Usage

Lib mode

1$ npm install mock-restful-server

Methods signatures

1function start(models, data, mode, port = 0)

*Note: without specifying the port argument a random port will be allocated by the system. The server listening address will be logged in the console at start.

Example

1const mockRestfulServer = require('mock-restful-server');

1const models = {
2  users: {
3    email: {
4      type: "string",
5      required: true
6    },
7    name: {
8      type: "string",
9      required: true
10    },
11    address: {
12      type: "string"
13    }
14  },
15  cars: {
16    name: {
17      type: "string",
18      required: true
19    },
20    brand: {
21      type: "string",
22      required: true
23    },
24    year: {
25      type: "number"
26    }
27  }
28}

*Note: supported model attributes are "type" and "required". type can be either "number", "string", "boolean", "array" or "map".

1const data = {
2  users: [{
3    email: 'john.doe@gmail.com',
4    name: 'John Doe',
5    address: 'Central Park Lake, NY'
6  }],
7  cars: [{
8    name: 'Mustang'
9    brand: 'Ford',
10    year: '1970'
11  }]
12}

1const mode = 'STRICT'

*Note: supported modes are STRICT and OPEN. OPEN is the default mode. In STRICT mode, two case will lead the server to throw an exception at saving time : trying to save a record with no model previously defined and trying to save a record having at least one field which doesn't exist in its model structure.

1const { port, stop } = mockRestfulServer.start(models, data, mode, 8080)

1// stop the server 
2stop()

CLI mode

1$ npm install -g mock-restful-server

1$ mock-restful-server --models=models.json --data=data.json --mode=STRICT --port=8080

License

MIT