npmpackage.info

Gathering detailed insights and metrics for mock-restful-server

Other packages similar to mock-restful-server

restful-mock-server

0.0.2

A mock server returning random JSON from schema.

mocker-api

3.0.2

This is dev support mock RESTful API.

axios-mock-server

0.19.1

RESTful mock server using axios

restful-dummy-server

1.0.4

This can be used to mock restful api responses.

mock-restful-server

A lightweight library to launch a mock restful server using models.

1.0.8

JavaScript

5.50 kB

1,399 1.8

Installations

npm install mock-restful-server

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

12.22.4

NPM Version

6.14.14 Score

79.1

Supply Chain

99.5

Quality

75.8

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

JavaScript

JavaScript (100%)

Developer

sebps

Download Statistics

Total Downloads

1,399

Last Day

Last Week

Last Month

Last Year

160

GitHub Statistics

15 Commits

1 Watching

1 Branches

1 Contributors

Bundle Size

15.12 kB

Minified

5.50 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.0.8

Package Id

mock-restful-server@1.0.8

Unpacked Size

1.12 MB

Size

169.57 kB

File Count

NPM Version

6.14.14

Node Version

12.22.4

Total Downloads

Cumulative downloads

Total Downloads

1,399

Last day

Compared to previous day

Last week

Compared to previous week

Last month

800%

Compared to previous month

Last year

-27.6%

160

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

chai mocha

Versions

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

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

License

Determines if the project has defined a license.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

1.8

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More