npmpackage.info

Gathering detailed insights and metrics for express-mock-restful

Other packages similar to express-mock-restful

mocker-api

3.0.2

This is dev support mock RESTful API.

mock-restful-express

0.0.2

A RESTful mock server powered by Express.js

restful-mock-middleware

0.7.0

A express restful mock middleware for frontend development.

dsg-mock-restful-express

0.0.3

A RESTful mock server powered by Express.js

express-mock-restful

express mock middleware that creates mocks for REST APIs. It will be helpful when you try to test your application without the actual REST API server.

1.1.3

JavaScript

198.35 kB

15,320 3.1

Installations

npm install express-mock-restful

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

12.18.4

NPM Version

6.14.6 Score

68.8

Supply Chain

98.4

Quality

74.3

Maintenance

Vulnerability

100

License

Pull Requests

Open

1

Total

2

Closed

1

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

xuxihai123

Download Statistics

Total Downloads

15,320

Last Day

Last Week

Last Month

125

Last Year

1,806

GitHub Statistics

2 Stars

19 Commits

1 Forks

2 Watching

3 Branches

1 Contributors

Bundle Size

481.38 kB

Minified

198.35 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.1.3

Package Id

express-mock-restful@1.1.3

Unpacked Size

25.09 kB

Size

5.71 kB

File Count

NPM Version

6.14.6

Node Version

12.18.4

Total Downloads

Cumulative downloads

Total Downloads

15,320

Last day

-92.9%

Compared to previous day

Last week

-69.8%

Compared to previous week

Last month

-42.9%

125

Compared to previous month

Last year

-43.8%

1,806

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

body-parser chalk debug path-to-regexp

Dev Dependencies

chokidar eslint express istanbul mocha supertest

Versions

express-mock-restful

express-mock is a express middleware that creates mocks for REST APIs. It will be helpful when you try to test your application without the actual REST API server.

Features:

🔥 Built in support for hot Mocker file replacement.
🚀 Quickly and easily configure the API via JSON.

Installation

1npm install express-mock-restful --save-dev

Usage

express-mock-restful dev support mock, configured in mocker.js. refresh mock with require('express-mock-restful').refresh api

1const mockMap = {
2  'GET /api/user': {
3    id: 1,
4    username: 'kenny',
5    sex: 6,
6  },
7  'GET /api/user/list': [
8    {
9      id: 1,
10      username: 'kenny',
11      sex: 6,
12    },
13    {
14      id: 2,
15      username: 'kenny',
16      sex: 6,
17    },
18  ],
19  'POST /api/login/account': (req, res) => {
20    const { password, username } = req.body;
21    if (password === '888888' && username === 'admin') {
22      return res.json({
23        status: 'ok',
24        code: 0,
25        token: 'sdfsdfsdfdsf',
26        data: {
27          id: 1,
28          username: 'kenny',
29          sex: 6,
30        },
31      });
32    } else {
33      return res.json({
34        status: 'error',
35        code: 403,
36      });
37    }
38  },
39  'DELETE /api/user/:id': (req, res) => {
40    console.log('---->', req.body);
41    console.log('---->', req.params.id);
42    res.send({ status: 'ok', message: '删除成功！' });
43  },
44};
45module.exports = mockMap;

simple usage

1const express = require('express');
2const path = require('path');
3const chokidar = require('chokidar');
4const app = express();
5+ const apiMocker = require('express-mock-restful');
6
7+ const mockFile = path.resolve(__dirname, './mocker.js');
8+ app.use(apiMocker(require(mockFile)));
9// or app.use(apiMocker({ entry: './mocker.js' }));
10
11app.listen(3000);
12console.log('server listen on http://127.0.0.1:3000/');

Using with refresh mock setting

1const express = require('express');
2const path = require('path');
3const chokidar = require('chokidar');
4const app = express();
5+ const apiMocker = require('express-mock-restful');
6
7+ const mockFile = path.resolve(__dirname, './mocker.js');
8+ app.use(apiMocker(require(mockFile)));
9
10// watch file change refresh mock setting
11+ chokidar.watch(mockFile).on('all', (event, path) => {
12+   try {
13+      delete require.cache[require.resolve(mockFile)];
14+      apiMocker.refresh(require(mockFile));
15+      console.log('refresh...');
16+  } catch (err) {
17+    console.log(err);
18+  }
19+ });
20
21app.listen(3000);
22console.log('server listen on http://127.0.0.1:3000/');

Using with Webpack

To use api mocker on your Webpack projects, simply add a setup options to your webpack-dev-server options:

Change your config file to tell the dev server where to look for files: webpack.config.js.

1const path = require('path');
2const HtmlWebpackPlugin = require('html-webpack-plugin');
3+ const apiMocker = require('express-mock-restful');
4
5module.exports = {
6  mocker: {
7    app: './src/index.js',
8    print: './src/print.js'
9  },
10  devtool: 'inline-source-map',
11+ devServer: {
12+   ...
13+   before(app){
14+     app.use(apiMocker(require('./mocker/index.js'));
15+   }
16+ },
17  plugins: [
18    new HtmlWebpackPlugin({
19      title: 'Development'
20    })
21  ],
22  output: {
23    filename: '[name].bundle.js',
24    path: path.resolve(__dirname, 'dist')
25  }
26};

Must have a file suffix! For example: ./mocker.js.

Let's add a script to easily run the dev server as well: package.json

1  {
2    "name": "development",
3    "version": "1.0.0",
4    "description": "",
5    "main": "webpack.config.js",
6    "scripts": {
7      "test": "echo \"Error: no test specified\" && exit 1",
8+     "start": "webpack-dev-server --open",
9      "build": "webpack"
10    },
11    "keywords": [],
12    "author": "",
13    "license": "MIT",
14    "devDependencies": {
15      ....
16    }
17  }

No vulnerabilities found.

10

Binary-Artifacts

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

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

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

0

Code-Review

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

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

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

3.1

/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