介绍

此项目根据 Easy Mock 修改添加相关功能, 运行和部署方式没变, 所以文档直接延用原来

基于 Easy Mock 添加的功能

• 传入参数定义
• 传参验证
• 感谢 @nostarsnow 增加的
  • 入参required
  • 接口列表页的入参列表展示
  • 预览页根据入参配置, 自动生成参数
• 接口标签, 用于接口筛选
• 接口初始化mock数据

特性

• 支持接口代理
• 支持快捷键操作
• 支持协同编辑
• 支持团队项目
• 支持 RESTful
• 支持 Swagger | OpenAPI Specification (1.2 & 2.0 & 3.0)
  • 基于 Swagger 快速创建项目
  • 支持显示接口入参与返回值
  • 支持显示实体类
• 支持灵活性与扩展性更高的响应式数据开发
• 支持自定义响应配置（例：status/headers/cookies）
• 支持 Mock.js 语法
• 支持 restc 方式的接口预览

链接

• 在线使用文档
• Easy Mock CLI - 基于 Easy Mock 快速生成 api.js 的命令行工具。

快速开始

在开始之前，假设你已经成功安装了 Node.js（>= v8.9）& MongoDB（>= v3.4）& Redis（>= v4.0）。

安装

$ git clone https://github.com/easy-mock/easy-mock.git
$ cd easy-mock && npm install

配置文件

找到 config/default.json，或者创建一个 config/local.json 文件，将如下需要替换的字段换成自己的配置即可。

不同环境会加载不同的配置文件，在此之前你应该对 node-config 有所了解。

{
  "port": 7300,
  "host": "0.0.0.0",
  "pageSize": 30,
  "proxy": false,
  "db": "mongodb://localhost/easy-mock",
  "unsplashClientId": "",
  "redis": {
    "port": 6379,
    "host": "localhost"
  },
  "blackList": {
    "projects": [], // projectId，例："5a4495e16ef711102113e500"
    "ips": [] // ip，例："127.0.0.1"
  },
  "rateLimit": { // https://github.com/koajs/ratelimit
    "max": 1000,
    "duration": 1000
  },
  "jwt": {
    "expire": "14 days",
    "secret": "shared-secret"
  },
  "upload": {
    "types": [".jpg", ".jpeg", ".png", ".gif", ".json", ".yml", ".yaml"],
    "size": 5242880,
    "dir": "../public/upload",
    "expire": {
      "types": [".json", ".yml", ".yaml"],
      "day": -1
    }
  },
  "fe": {
    "copyright": "",
    "storageNamespace": "easy-mock_",
    "timeout": 25000,
    "publicPath": "/dist/"
  }
}

背景图配置：

登录页的背景图服务目前支持 Unsplash 与 Bing。

如果 unsplashClientId 配置留空，默认由 Bing 提供服务。

注意：

• publicPath 默认是 '/dist/'。如有需要，可以将其替换成自己的 CDN；
• 关于 fe 的配置，一旦发生改变应该重新执行 build 命令。

启动

$ npm run dev
# 访问 http://127.0.0.1:7300

更多命令

# 前端静态资源构建打包
$ npm run build

# 以生产环境方式启动，需要提前执行 build
$ npm run start

# 单元测试
$ npm run test

# 语法检测
$ npm run lint

服务器部署

在此之前请先配置好配置文件。

PM2

当在内网服务器部署时，推荐使用 PM2 来守护你的应用进程。

全局安装 PM2

$ [sudo] npm install pm2 -g

用 PM2 启动

在此之前，你应该已经完成了 build。

$ NODE_ENV=production pm2 start app.js

增加功能截图

1. 入参required

2. 接口列表页的入参列表展示

3. 预览页根据入参配置, 自动生成参数

4. 配置项目标签和接口初始化mock

5. 接口标签配置

6. 接口标签筛选