一、什么是Easy Mock
Easy Mock 是一个可视化，并且能快速生成模拟数据的持久化服务。
特性
- 支持接口代理
- 支持快捷键操作
- 支持协同编辑
- 支持团队项目
- 支持 RESTful
- 支持 Swagger | OpenAPI Specification (1.2 & 2.0 & 3.0)
- 基于 Swagger 快速创建项目
- 支持显示接口入参与返回值
- 支持显示实体类
- 支持灵活性与扩展性更高的响应式数据开发
- 支持自定义响应配置（例：status/headers/cookies）
- 支持 Mock.js 语法
- 支持 restc 方式的接口预览
二、准备环境
你的电脑已经安装了 Node.js（v8.x, 不支持 v10.x）& MongoDB（>= v3.4）& Redis（>= v4.0）& Git。
MongoDB安装教程地址：https://lirenguo.github.io/2019/12/16/Windows10-%E5%AE%89%E8%A3%85MongoDB4-x%E7%89%88%E6%9C%AC/
Redis安装教程地址：<https://lirenguo.github.io/2019/12/16/Windows10-%E5%AE%89%E8%A3%85Redis/
三、安装
随便找一个文件夹（没有中文，空格的文件夹）
1 | // 在Git命令行中操作 |
2 | $ git clone https://github.com/easy-mock/easy-mock.git |
3 | // 打开cmd,并定位到刚刚拉下来的easy-mock文件夹的根目录中 |
4 | $ npm install |
四、配置文件讲解
找到 config/default.json，或者创建一个 config/local.json 文件，将如下需要替换的字段换成自己的配置即可。
不同环境会加载不同的配置文件，在此之前你应该对 node-config 有所了解。
配置自己的mongodb的路径
1 | { |
2 | "port": 7300, |
3 | "host": "0.0.0.0", |
4 | "pageSize": 30, |
5 | "proxy": false, |
6 | "db": "mongodb://localhost:27017/easy-mock", |
7 | "unsplashClientId": "", |
8 | "redis": { |
9 | "keyPrefix": "[Easy Mock]", |
10 | "port": 6379, |
11 | "host": "localhost", |
12 | "password": "", |
13 | "db": 0 |
14 | }, |
15 | "blackList": { |
16 | "projects": [], // projectId，例："5a4495e16ef711102113e500" |
17 | "ips": [] // ip，例："127.0.0.1" |
18 | }, |
19 | "rateLimit": { // https://github.com/koajs/ratelimit |
20 | "max": 1000, |
21 | "duration": 1000 |
22 | }, |
23 | "jwt": { |
24 | "expire": "14 days", |
25 | "secret": "shared-secret" |
26 | }, |
27 | "upload": { |
28 | "types": [".jpg", ".jpeg", ".png", ".gif", ".json", ".yml", ".yaml"], |
29 | "size": 5242880, |
30 | "dir": "../public/upload", |
31 | "expire": { |
32 | "types": [".json", ".yml", ".yaml"], |
33 | "day": -1 |
34 | } |
35 | }, |
36 | "ldap": { |
37 | "server": "", // 设置 server 代表启用 LDAP 登录。例："ldap://localhost:389" 或 "ldaps://localhost:389"（使用 SSL） |
38 | "bindDN": "", // 用户名，例："cn=admin,dc=example,dc=com" |
39 | "password": "", |
40 | "filter": { |
41 | "base": "", // 查询用户的路径，例："dc=example,dc=com" |
42 | "attributeName": "" // 查询字段，例："mail" |
43 | } |
44 | }, |
45 | "fe": { |
46 | "copyright": "", |
47 | "storageNamespace": "easy-mock_", |
48 | "timeout": 25000, |
49 | "publicPath": "/dist/" |
50 | } |
51 | } |
五、启动
1 | $ npm run dev |
2 | # 访问 http://127.0.0.1:7300 |
更多命令
1 | # 前端静态资源构建打包 |
2 | $ npm run build |
3 | |
4 | # 以生产环境方式启动，需要提前执行 build |
5 | $ npm run start |
6 | |
7 | # 单元测试 |
8 | $ npm run test |
9 | |
10 | # 语法检测 |
11 | $ npm run lint |