readme.md

node-mock-server

File based Node REST API mock server

Getting Started

This application requires Node 6 or higher. For Node <6 please use [email protected] For Node <4 please use [email protected]

1. Install npm package:

$ npm install node-mock-server --save-dev

2. Start init process:

$ node node_modules/node-mock-server/init

Options

node-mock-server options

Usage examples

node-mock-server usage examples

Features

• Node.js and file based (folder structure)
• Node Mock Server UI
• Functions in mock data
• Faker included
• Query params in mock data
• Dynamic path params in mock data
• Expected responses
• Middleware responses
• Express Middleware
• Error cases
• Swagger import
  • DTO import
  • DTO response function
• Response validation
• Response header
• DTO to Class converter
• Collections
• Tunnel

CLI

$ node <nodeScript> --help

  Usage
    $ node <nodeScript> [--version] [--help] <command> [<args>]

  Options
    $                  start mock server
    $ --version        print node-mock-server version
    $ --help           print help
    $ swagger-import   run a swagger import
    $ validate         run a validation for all mock data
    $ collections      print all available collections
    $ collection <id>  activate collection

  Examples
    $ node demo/index.js --version
    $ node demo/index.js collections

Demo

git clone https://github.com/smollweide/node-mock-server.git
cd node-mock-server
npm install
node demo

License

MIT License

Changelog

Please see the Releases