Skip to content
基于 Easy-mock 进行扩展,添加 serviceName 字段以支持 EntityService
JavaScript Vue CSS HTML
Branch: master
Clone or download
Pull request Compare This branch is 2 commits ahead, 43 commits behind easy-mock:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
build
config
controllers
middlewares
models
proxy
public
test
util
views
.babelrc
.editorconfig
.eslintrc.js
.gitignore
.postcssrc.js
CHANGELOG.md
LICENSE
README.md
README.zh-CN.md
app.js
circle.yml
package.json
router-config.js
yarn.lock

README.md

Node.js Version MongoDB 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 (>= v7.4) and MongoDB (>= v3.4).

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.

{
  "db": "mongodb://localhost/{DATABASE-NAME}",
  "unsplashClientId": "Background, see section below. (optional)",
  "jwt": {
    "secret": "shared-secret"
  },
  "fe": {
    "publicPath": "/dist/",
    "APIPrefix": "http://127.0.0.1:7300/api",
    "storageNamespace": "cookies & localStorage namespace"
  }
}

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

Configure APIPrefix Correctly

If you deploy Easy Mock by yourself, you should replace APIPrefix to your own server uri. eg:

Assume your server location is http://example.com, the APIPrefix should be http://example.com/api.

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

License

GPL-3.0

You can’t perform that action at this time.