npmpackage.info

Gathering detailed insights and metrics for mock-restful-service

Other packages similar to mock-restful-service

mock-restful

0.1.7

a mock rest service for development purposes

mock-restful-api

0.1.0

This is dev support mock RESTful API. Refer to django-rest-framework implementation.

bean-mock-api-service

0.1.0

Bean mock Restful API service

restful-ng-mock

0.3.0

Quickly mock up common HTTP service API patterns.

Gathering detailed insights and metrics for mock-restful-service

mock-restful-service

A simple to use module for creating mock REST services

1.0.1

JavaScript

10.81 kB

857 1.3

Installations

npm install mock-restful-service

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

8.3.0

NPM Version

5.5.1 Score

68.5

Supply Chain

91.4

Quality

74.6

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

1

Closed

0

Merged

1

Issues

Open

1

Total

1

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

JavaScript

JavaScript (100%)

Developer

jrnelson333

Download Statistics

Total Downloads

857

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

8 Commits

1 Watching

1 Branches

1 Contributors

Bundle Size

33.16 kB

Minified

10.81 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.0.1

Package Id

mock-restful-service@1.0.1

Size

2.92 kB

NPM Version

5.5.1

Node Version

8.3.0

Total Downloads

Cumulative downloads

Total Downloads

857

Last day

Compared to previous day

Last week

Compared to previous week

Last month

450%

Compared to previous month

Last year

-26.4%

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

colors deep-equal

Versions

Mock Restful Service

Simple to use express middleware for creating mock REST services. Define routes (sets of requests and responses) as json objects and configure the express middleware to use the routes.

Features

Create custom responses for each route (request path and method)
Create custom responses based on the requests body (headers coming soon!) as well as creating a default response
URL (request path) pattern matching with Regex
Create required fields for a request body and specify response status/body if fields are not met
Specify '404 Not Found' response (status/body) OR pass through if route is not founc

Sample Use

Below is the most basic use of mock-restful-service

1const express = require('express');
2const mockRestfulSerice = require('mock-restful-service');
3
4const app = express();
5
6const routes = [
7        {
8            path: '/sample',
9            method: 'get',
10            defaultResponse: {
11                status: 200,
12                body: { message: 'Hello World!' }
13            }
14        },
15    ]
16
17app.use(mockRestfulSerice(routes));
18
19app.listen(8002, () => {
20    console.log('server now listening on 8002. Open http://localhost:8002');
21});
22

Route Definition

key	Type(s)	Required?	Description
path	string, regex	true	Partial URL of request
regex	boolean	false	True if using regex for path param
method	string	true	HTTP method (get, post, put, delete, etc.)
requiredFields	Array	false	An array of the required fields (not applicable to get method)
requiredFieldsResponse	Object	false	The status and the body if any of the required fields are missing
defaultResponse	Object	true	The status and body if none of the responseMappings are matched (see below)
responseMappings	Array	false	An array of request/response pairs. If the request is received, then the response will be returned

Example

1{
2        path: '/user',
3        regex: false,
4        method: 'post', 
5        requiredFields: ['username'],
6        requiredFieldsResponse: {
7            status: 400,
8            body: { error: 'Required field validation'}
9        },
10        defaultResponse: {
11            status: 201,
12            body: { message: 'created'}
13        },
14        responseMappings: [
15            {
16                request: {
17                    body: { username: 'jdoe' }
18                },
19                response: {
20                    status: 400,
21                    body: { error: 'this username already exists' }
22                }
23            }
24        ]
25    },

No vulnerabilities found.

10

Binary-Artifacts

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

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

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

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

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

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

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

45 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-g7q5-pjjr-gqvp
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-332q-7ff2-57h2

Score

1.3

/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