https://github.com/smollweide/node-mock-server
File based Node REST API mock server
https://github.com/smollweide/node-mock-server
datatransferobject dto faker mock mock-data node rest-api ssl swagger
Last synced: 2 months ago
JSON representation
File based Node REST API mock server
- Host: GitHub
- URL: https://github.com/smollweide/node-mock-server
- Owner: smollweide
- License: mit
- Created: 2016-03-06T23:06:33.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2025-08-12T05:27:58.000Z (8 months ago)
- Last Synced: 2025-10-26T22:33:47.431Z (5 months ago)
- Topics: datatransferobject, dto, faker, mock, mock-data, node, rest-api, ssl, swagger
- Language: JavaScript
- Homepage:
- Size: 2.13 MB
- Stars: 255
- Watchers: 6
- Forks: 63
- Open Issues: 45
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# node-mock-server
> File based Node REST API mock server
[](https://travis-ci.org/smollweide/node-mock-server)
[](https://badge.fury.io/js/node-mock-server)
[](https://www.npmjs.com/package/node-mock-server)
[](https://github.com/namics/eslint-config-namics)
## Getting Started
This application requires Node `6` or higher.
For Node `<6` please use `node-mock-server@0.22.1`
For Node `<4` please use `node-mock-server@0.11.0`
##### 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](/doc/readme-options.md)
### Usage examples
[node-mock-server usage examples](/doc/readme-usage-examples.md)
## Features
- Node.js and file based ([folder structure](/doc/readme-folder-structure.md))
- [Node Mock Server UI](/doc/readme-ui-documentation.md)
- [Functions in mock data](/doc/readme-mock-functions.md)
- [Faker included](/doc/readme-faker.md)
- [Query params in mock data](/doc/readme-query-params.md)
- [Dynamic path params in mock data](/doc/readme-path-params.md)
- [Expected responses](/doc/readme-expected-response.md)
- [Middleware responses](/doc/readme-middleware.md)
- [Express Middleware](/doc/readme-express-middleware.md)
- [Error cases](/doc/readme-expected-response.md)
- [Swagger import](/doc/readme-swagger-import.md)
- DTO import
- DTO response function
- [Response validation](/doc/readme-response-validation.md)
- [Response header](/doc/readme-response-header.md)
- [DTO to Class converter](/doc/readme-dto-2-class.md)
- [Collections](/doc/readme-collections.md)
- [Tunnel](/doc/readme-tunnel.md)
## CLI
```
$ node --help
Usage
$ node [--version] [--help] []
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 activate collection
Examples
$ node demo/index.js --version
$ node demo/index.js collections
```
## Demo
```shell
git clone https://github.com/smollweide/node-mock-server.git
cd node-mock-server
npm install
node demo
```
## License
[MIT License](https://github.com/smollweide/node-mock-server/blob/master/LICENSE)
## Changelog
Please see the [Releases](https://github.com/smollweide/node-mock-server/releases)