koa-mock-restful

koa-mock-restful is a koa 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 koa-mock-restful --save-dev

Usage

koa-mock-restful dev support mock, configured in mocker.js.

1const mockMap = {
2  'GET /api/user': {
3      username: 'admin',
4      sex: 5,
5    },
6    'GET /repos/hello': (ctx, next) => {
7      ctx.body = {
8        text: 'this is from mock server',
9      };
10    },
11    'GET /api/userinfo/:id': (ctx, next) => {
12      ctx.body = {
13        id: ctx.params.id,
14        username: 'kenny',
15      };
16    },
17    'GET /api/user/list/:id/:type': (ctx, next) => {
18      ctx.body = {
19        id: ctx.params.id,
20        type: ctx.params.type,
21      };
22    },
23  
24    'POST /api/login/account': (ctx, next) => {
25      const {password, username} = ctx.request.body;
26      if (password === '888888' && username === 'admin') {
27        ctx.body =  {
28          status: 'ok',
29          code: 0,
30          token: 'sdfsdfsdfdsf',
31          data: {
32            id: 1,
33            username: 'kenny',
34            sex: 6,
35          },
36        };
37      } else {
38        ctx.body = {
39          status: 'error',
40          code: 403,
41        };
42      }
43    },
44    'DELETE /api/user/:id': (ctx, next) => {
45      ctx.body = {status: 'ok', message: '删除成功！', id: ctx.params.id};
46    },
47}
48module.exports = mockMap;

apiMocker

1apiMocker({entry:'./mocker.js',debug:true})

Using with koa

1const path = require('path');
2const koa = require('koa');
3+ const apiMocker = require('koa-mock-restful');
4
5const app = koa();
6
7+ app.use(apiMocker({entry:'./mocker/index.js',debug:true});
8app.listen(8080);