qgqceo / easy-mock

一个可视化, 并且能快速生成模拟数据的持久化服务.

特别感谢在线服务的服务器赞助商

介绍

如果没有内网部署的条件，推荐使用 在线服务。

Easy Mock 是一个可视化，并且能快速生成 模拟数据 的持久化服务。

特性

• 支持接口代理
• 支持快捷键操作
• 支持协同编辑
• 支持团队项目
• 支持 Restful
• 支持 Swagger 1.2 & 2.0
  • 基于 Swagger 快速创建项目
  • 支持显示接口入参与返回值
  • 支持显示实体类
• 支持灵活性与扩展性更高的响应式数据开发
• 支持 Mock.js 语法
• 支持 restc 方式的接口预览

链接

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

快速开始

在开始之前，假设你已经成功安装了 Node.js (v7.4 以上) 和 MongoDB (v3.4 以上)

安装

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

配置文件

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

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

注意

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

{
  "db": "mongodb://localhost/{数据库名}",
  "unsplashClientId": "可空。背景图配置，见下面说明。",
  "jwt": {
    "secret": "shared-secret"
  },
  "fe": {
    "publicPath": "/dist/",
    "APIPrefix": "http://127.0.0.1:7300/api",
    "uploadAPI": "你的上传接口地址，头像上传需要。",
    "storageNamespace": "cookies & localStorage 的命名空间。"
  }
}

背景图配置

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

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

启动

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

更多命令

# 前端静态资源构建打包
$ 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

正确配置 APIPrefix

当在服务器上部署时，我们应该将 APIPrefix 配置成服务器的地址。

例如服务地址为：http://example.com

APIPrefix 应配置为：http://example.com/api

更新日志

Release 中记录了每个版本的详细更改。

贡献

Easy Mock 目前由 大搜车无线架构团队 进行维护。如有问题，欢迎提出 issues，并通过 pull-request 共同维护。不过在此之前，请务必阅读这份 贡献指南。

实时反馈

实时问题可以加 QQ 群 595325417 进行反馈，当然也可以扫描下面的二维码加群。

在使用的团队或公司

如有内网部署，请务必通过 pull-request 的方式在此添加公司或者团队。

• 大搜车

核心贡献者

chuangker

License

GPL-3.0