snb-mock-middleware

Mock middleware for mocking restful APIs.

Install

yarn add snb-mock-middleware -D

or

npm install --save-dev snb-mock-middleware

Usage

Used in the Node environment

1const express = require('express');
2const path = require('path');
3const createtMockMiddleware = require('./dist/index');
4var app = express();
5app.use(
6  createtMockMiddleware({
7    cwd: path.join(__dirname, '/'),
8  }),
9);
10
11const server = app.listen(3000, () => {
12  const host = server.address().address;
13  const port = server.address().port;
14  console.log('Example app listening at http://%s:%s', host, port);
15});

Used in a front-end development environment

1module.exports = {
2  devServer: {
3    before: (app) => {
4      app.use(
5        createMock({
6          cwd: path.join(__dirname, '/'),
7        }),
8      );
9    },
10  }
11}

Mock files

For example in file /mock/api.js, you can have content

1const mockjs = require('mockjs');
2
3const getActivities = [
4  {
5    id: 'trend-1',
6    updatedAt: new Date(),
7    user: {
8      name: '曲丽丽',
9    },
10    group: {
11      name: '高逼格设计天团',
12      link: 'http://github.com/',
13    },
14    project: {
15      name: '六月迭代',
16      link: 'http://github.com/',
17    },
18    template: '在 @{group} 新建项目 @{project}',
19  },
20];
21
22exports.default = {
23  'GET /api/activities': getActivities,
24  'POST /api/forms': (req, res) => {
25    res.send({ message: 'Ok' });
26  },
27  'GET /api/tags': mockjs.mock({
28    'list|100': [{ name: '@city', 'value|1-100': 150, 'type|0-2': 1 }],
29  }),
30};
31

FAQ

Move to: issues