# Mock Data

Mock 数据是前端开发过程中必不可少的一环，是分离前后端开发的关键链路。通过预先跟服务器端约定好的接口，模拟请求数据甚至逻辑，能够让前端开发更加独立自主，不会被服务端的开发所阻塞。

# 约定式 Mock 文件

TIP

admin-element-vue-vite-ts 基于 vite (opens new window) 实现了本地 MOCK 服务，并集成了mockjs (opens new window)。

/mock 文件夹下所有文件为 mock 文件。

比如：

.
├── mock
    ├── global.js
    ├── global.js
    ├── pagesample.js
    └── users.js

1
2
3
4
5
6

/mock 下的 ***.js 会被解析为 mock 文件。

# mock文件内容格式

module.exports = {
  
  // 'method url': (req, res) => {}   

  'get /404': (req, res) => {
      res.send({
        timestamp: 1513932643431,
        status: 404,
        error: 'Not Found',
        message: 'No message available',
        path: '/404',
      }, 404);
  }
};

1
2
3
4
5
6
7
8
9
10
11
12
13
14

注意：'method url': (req, res) => {} 代码 method与url中间有一个空格。

# method 支持

'method url': (req, res) => {} 中 method 支持 ['get','post','put','patch','delete','head','options']。

# req 参数

'method url': (req, res) => {} 中 req 常用值：req.headers 、 req.body、 req.query。

# res 参数

'method url': (req, res) => {} 中 res 常用方法：res.send({返回值}, 状态码默认200) 。

# 样例代码

/mock/user.js 代码

const mockjs= require('mockjs');
const { VITE_APP_APIHOST } = process.env;
const ajaxHeadersTokenKey = 'x-token';
const mock = {};

mock[`GET ${VITE_APP_APIHOST}/user/info`] = (req, res) => {
    const headers = req.headers;
    if (headers[ajaxHeadersTokenKey] === 'admin') {
        res.send({
          code: 0,
          data: {
            id: 1,
            name: 'Admins',
            avatar: '',
            roles: ['admin'],
          },
        });
    } else if (headers[ajaxHeadersTokenKey] === 'user') {
        res.send({
          code: 0,
          data: {
            id: 2,
            name: 'Users',
            avatar: '',
            roles: ['user'],
          },
        });
    } else if (headers[ajaxHeadersTokenKey] === 'test') {
        res.send({
          code: 0,
          data: {
            id: 3,
            name: 'Tests',
            avatar: '',
            roles: ['test'],
          },
        });
    } else {
        res.send({
          code: 10002,
          data: {},
          msg: '未登录',
        });
    }

};

mock[`GET ${VITE_APP_APIHOST || ''}/user/message`] = (req, res) => {
    res.send({
      code: 0,
      data: mockjs.mock('@integer(0,99)'),
    });
};
  
mock[`POST ${VITE_APP_APIHOST || ''}/user/login`] = (req, res) => {
    const { password, username } = req.body;
    const send = { code: 0, data: {}, msg: '' };
    if (username === 'admin' && password === '123456') {
        send['data'] = {
        token: 'admin',
        };
    } else if (username === 'user' && password === '123456') {
        send['data'] = {
        token: 'user',
        };
    } else if (username === 'test' && password === '123456') {
        send['data'] = {
        token: 'test',
        };
    } else {
        send['code'] = 201;
        send['msg'] = 'Wrong username or password';
    }

    res.send(send);
};
  
mock[`POST ${VITE_APP_APIHOST || ''}/user/register`] = (req, res) => {
    res.send({
      code: 0,
      data: '',
      msg: '',
    });
};
  

module.exports = {
  ...mock
};

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# 开源的api文档管理系统

线上有很多开源的api文档管理系统，如果个人或公司满足业务需求条件的情况下，可以自己进行安装、调试以供开发使用。

# 1、YApi(百度)

YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。Github (opens new window)

# 2、阿里的RAP（JAVA）

注意：

新版 RAP2 已不是 JAVA 开发具体请看说明 (opens new window)

Web接口管理工具，开源免费，接口自动化，MOCK数据自动生成，自动化测试，企业级管理。阿里妈妈MUX团队出品！阿里巴巴都在用！1000+公司的选择！一直被抄袭，从未被超越。 GitHub (opens new window)

# 3、ShowDoc（PHP）

国内开源的非常好用的一款API文档管理系统，安装也非常方便，只需将源代码放到项目目录下自动安装运行即可。 GitHub (opens new window)

当然还有一些其它的产品 swagger (opens new window) 、eoapi (opens new window)、postman (opens new window) 等等，这里就不一一列举了，自己有兴趣可以自己去查找资料。

← 与服务端交互构建与发布 →