https://github.com/soon08/mockjs-webpack-plugin
A mockjs webpack plugin
https://github.com/soon08/mockjs-webpack-plugin
mock-data mockjs webpack-plugin
Last synced: 4 months ago
JSON representation
A mockjs webpack plugin
- Host: GitHub
- URL: https://github.com/soon08/mockjs-webpack-plugin
- Owner: soon08
- License: mit
- Created: 2017-12-24T05:54:30.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-12-06T03:45:30.000Z (over 1 year ago)
- Last Synced: 2025-10-08T09:52:52.649Z (8 months ago)
- Topics: mock-data, mockjs, webpack-plugin
- Language: JavaScript
- Size: 1.33 MB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MockjsWebpackPlugin
[中文readme](./readme-zh.md)
> Quickly build mock service for your project as a webpack plugin based on [mockjs](https://github.com/nuysoft/Mock)
# What is the problem this plugin solved
Through the way of webpack plugin, we can quickly build a mock service of project for parallel development in front-end and back-end separation mode.
# Start up
## Install
```
npm install --save-dev webpack mockjs-webpack-plugin
```
## Config
Add a `mock data storage folder` in your project.
```
.
├── app //project folder
├── dist
├── config
├── src
├── mock //mock data folder
⎪ ├── data.js
⎪ ├── data.json
...
```
config proxy and mock-webpck-plugin in `webpack.config.js`
```javascript
// import plugin
const MockjsWebpackPlugin = require("mockjs-webpack-plugin");
module.exports = {
entry: "./index.js",
output: {
path: path.resolve(__dirname, "dist"),
filename: "my-first-webpack.bundle.js"
},
// config plugin
plugins: [
new MockjsWebpackPlugin({
// mock data folder path
path: path.join(__dirname, "./mock"),
// mock server port, avoid collision with application port
port: 3000
})
],
// config proxy
devServer: {
// application port
port: 5001,
proxy: {
// mock server url
"/": "http://localhost:3000/"
}
}
};
```
if you want to set a special url for mock service, you can use webpack proxy like this:
```javascript
...
module.exports = {
...
// config proxy
devServer: {
// application port
port: 5001,
proxy: {
'/api': {
target: 'http://localhost:3000/',
pathRewrite: {
// set url rewrite, for example,
// http://localhost:5001/api/getData -> http://localhost:3000/getData
'^/api': ''
}
}
}
}
};
```
_When you add a mock data file, do not need to modify the webpack config file but **restart the application**_
# OPTIONS
```javascript
new MockjsWebpackPlugin(options);
```
* options.path mock data folder path
* options.port the port of the mock server, default 3000
# Mock Data
`Mock Data` here is not a real JSON file, and more like a JS file.
When we just want to return data without any processing, a json mock file will be proper. So you want to use the following format.
```js
/**
* Json data file
*
* @url /json/data
*
* Here you can write a detailed description
* of the parameters of the information.
*
* Parameter description and other instructions.
* uid: user ID
* name: username
* email: the email
* etc.
*/
{
"code": 0,
"result|5": [
{
"uid|+1": 1,
"name": "@name",
"email": "@email"
}
]
}
```
You can read the file content like this
- title： `Json data file`
- url： `/json/data`
- Description：
```
Here you can write a detailed description
of the parameters of the information.
Parameter description and other instructions.
uid: user ID
name: username
email: the email
etc.
```
- data content： the rest part
Then you can access the through the browser.
In addition, we can use the JS file directly, which is very useful when we need to check the input parameters.
``` js
/**
* JS data file
*
* @url /js/js-data-file
*
* Export data by using the JS file directly.
*/
module.exports = {
"code": function () { // simulation error code, 1/10 probability of error code 1.
return Math.random() < 0.1 ? 1 : 0;
},
"list|5-10": [
{"title": "@title", "link": "@url"}
]
};
```
Or export `function`.
``` js
/**
* JS function file
*
* @url /js/js-func-file/user?uid=233
*
* GET: Request method and parameter
* uid This is the requested userID
*
* Here you can write a detailed description
* of the parameters of the information.
*/
module.exports = function(req) {
var uid = req.query.uid;
if (!uid) {
return {
code: -1,
msg: "no uid"
};
}
return {
code: 0,
data: {
uid: +uid,
name: "@name",
"age|20-30": 1,
email: "@email",
date: "@date"
}
};
};
```
_All above data comes from `mockjs` syntax，you can read docs and samples from website of mockjs to get more_
mock data desciption comes from [52cik/express-mockjs](https://github.com/52cik/express-mockjs)
## Mock JSON
* [Mock.js 0.1 doc](https://github.com/nuysoft/Mock/wiki)
* [Mock samples](http://mockjs-lite.js.org/docs/examples.html)
#ChangeLog
version 3.0.0 -- 2019.04.07
1. nothing updated! Just use `npm version ` and then i find my package.json has been updated to 3.0.0
version 2.0.0 -- 2019.04.06
1. support hot reload mock files changes, like add new file or update content.
# Support
This repo is coming from [MarxJiao/mock-webpack-plugin](.https://github.com/MarxJiao/mock-webpack-plugin) and [52cik/express-mockjs](https://github.com/52cik/express-mockjs).
Thanks this two author, [Marx(MarxJiao)](https://github.com/MarxJiao) and [楼教主(52cik)](https://github.com/52cik)