A persistent service that generates mock data quickly and provids visualization view.
Clone or download
Permalink
Failed to load latest commit information.
.circleci chore(ci): migrate to CircleCI 2.0 Jan 16, 2018
.github docs(github): update template Sep 9, 2017
build feat(server): support LDAP login (fixed #138) May 24, 2018
config feat(server): support LDAP login (fixed #138) May 24, 2018
controllers feat(server): support proxy mode pass request headers (resolve #182) Jun 7, 2018
middlewares fix(server): fix 404 caused by `BaseURL` Jan 17, 2018
models refactor(server): update to koa2 Jan 16, 2018
proxy feat(server): use redis Jan 16, 2018
public [ImgBot] optimizes images Sep 9, 2017
test feat(server): support LDAP login (fixed #138) May 24, 2018
util feat(server): support LDAP login (fixed #138) May 24, 2018
views docs: modified some details of docs (#207) Sep 5, 2018
.babelrc chore(build): optimized configuration Jan 16, 2018
.editorconfig first commit Sep 1, 2017
.eslintrc.js refactor(server): update to koa2 Jan 16, 2018
.gitignore feat(server): support upload Nov 29, 2017
.postcssrc.js refactor(browser): markdown style Jan 16, 2018
CHANGELOG.md feat(server): support LDAP login (fixed #138) May 24, 2018
LICENSE chore: 更新 LICENSE Sep 5, 2017
README.md docs: update who deployed Easy Mock Sep 3, 2018
README.zh-CN.md docs: update who deployed Easy Mock Sep 3, 2018
app.js feat(server): support configuration host & remove APIPrefix Jan 16, 2018
jest.config.js test(project): add test cases for create Jan 16, 2018
package-lock.json chore: bump version to 1.6.0 May 24, 2018
package.json chore: bump version to 1.6.0 May 24, 2018
router-config.js feat(server): use redis Jan 16, 2018

README.md

Node.js Version MongoDB Version Redis Version Build Status Coverage Status js-standard-style License Chat

Thanks to Souche Inc. which provides the server to hold an online service.

Souche Inc.

Links

Introduction

If you're unable to deploy an Easy Mock service by yourself, the online service is recommended.

Easy Mock is a persistent service that generates mock data quickly and provids visualization view.

Features

  • Support API proxying
  • Convenient shortcuts
  • Support Collaborative editing
  • Support team project
  • Support RESTful
  • Support Swagger | OpenAPI Specification (1.2 & 2.0 & 3.0)
    • Create project quickly based on Swagger
    • Support displaying parameters and the return value
    • Support displaying class model
  • More flexible and extensible in response data
  • Support for custom response configuration (example: status/headers/cookies)
  • Use Mock.js schema
  • Support restc to preview API

Quick Start

Before starting, we assume that you're already have installed Node.js (>= v8.9) & MongoDB (>= v3.4) & Redis(>= v4.0).

Installation

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

Configuration

Find config/default.json or create config/local.json to overwrite some configuration.

Easy Mock will load different configuration files according to your environment. Reference to node-config to get more information because Easy Mock uses node-config as its configuration module.

{
  "port": 7300,
  "host": "0.0.0.0",
  "pageSize": 30,
  "proxy": false,
  "db": "mongodb://localhost/easy-mock",
  "unsplashClientId": "",
  "redis": {
    "keyPrefix": "[Easy Mock]",
    "port": 6379,
    "host": "localhost",
    "password": "",
    "db": 0
  },
  "blackList": {
    "projects": [], // projectId, e.g."5a4495e16ef711102113e500"
    "ips": [] // ip, e.g. "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
    }
  },
  "ldap": {
    "server": "", // Set server to enable LDAP login. e.g. "ldap://localhost:389" or "ldaps://localhost:389"(use SSL)
    "bindDN": "", // Username,e.g. "cn=admin,dc=example,dc=com"
    "password": "",
    "filter": {
      "base": "", // Base where we can search for users,e.g. "dc=example,dc=com"
      "attributeName": "" // e.g. "mail" or "email" etc.
    }
  },
  "fe": {
    "copyright": "",
    "storageNamespace": "easy-mock_",
    "timeout": 25000,
    "publicPath": "/dist/"
  }
}

Note:

  • The default value of publicPath is '/dist/'. You can replace it to your own CDN if necessary.
  • If you changed some configuration of fe, you should run build command to adapt that changes.

Background:

Easy Mock supports two background service, Unsplash and Bing.

If you leave unsplashClientId blank, the background will be provided by Bing.

Launch

$ npm run dev
# Visit http://127.0.0.1:7300

More Commands

# Build front-end assets
$ npm run build

# Run Easy Mock as production environment (You should run `build` first)
$ npm run start

# Run unit test
$ npm run test

# Test lint
$ npm run lint

Deployment

Please configure your configuration files before this step.

PM2

We're recommending you to use PM2 as your daemon process.

Install PM2 Globally

$ [sudo] npm install pm2 -g

Launch via PM2

You should run build before this step.

$ NODE_ENV=production pm2 start app.js

Releases

Refer to Release and you'll get all the releases and theirs changelog.

Contributing

Easy Mock is now maintained by Mobi-Architecture team of Souche Inc. If you have any question about this project, you're welcome to post Issues or make some Pull Requests. Before contributing, we think you'd better read the contributing guide.

Real-Time Feedback

You may make some real-time feedback via QQ group.

QQ is the most popular IM software in China and you can get it downloaded via http://en.qq.com/.

The QQ group number is 595325417, and here's the QR code of the group:

Who Deployed Easy Mock

If you deployed Easy Mock in your own server, please tell us

Core Contributors


chuangker

XadillaX

ostoc

xinyu198736

License

GPL-3.0