第一步
准备node环境
参见[nodejs官网][http://nodejs.cn/]
验证是否安装配置成功:
node -v
在这个版本上升级node
npm install -g n
n stable //升级到稳定版
n v0.10.26 //升级到指定版本
至此node环境准备完成。
第二步
生成项目代码,以dva为例
安装dva
npm install dva-cli -g
dva -v
生成代码
dva new dva-name
cd dva-name
启动项目代码
npm start
在Linux系统里边.开头的文件是隐藏文件
ll -a 用这个命令查看隐藏文件
第三步
安装mock2easy
npm install mock2easy –save-dev
安装完成之后 , 进入 .roadhogrc.mock.js 文件中。 使用linux命令进入
vim .roadhogrc.mock.js # 编辑文件
esc键 > : > x # 退出编辑并保存
加入代码如下:
var mock2easy = require('mock2easy');
var defaultConfig = {
port: 8006,
lazyLoadTime: 3000,
database: 'mock2easy',
doc: 'doc',
ignoreField: [],
interfaceSuffix: '.json',
preferredLanguage: 'en'
};
mock2easy(defaultConfig, function (app) {
app.listen(defaultConfig.port, function () {
console.log(('mock2easy is starting , please visit : http://127.0.0.1:' + defaultConfig.port).bold.cyan);
});
});
进入.roadhogrc 文件中。
vim .roadhogrc
加入代码:
"proxy": {
"/api": {
"target": "http://localhost:8006",
"changeOrigin": true,
"secure": false,
"pathRewrite": { "^/api" : "" }
}
}
重启服务器,然后访问: xxx:8006
如图:
第四步
gitbook文档自动生成(这个功能只能生成之后手工启动服务)
gitbook 安装
npm install -g gitbook-cli
gitbook -V # 查看gitbook是否安装成功
cd doc # 找到上面的mock2easy的项目地址,进入doc
gitbook init # 文件夹下面执行
可以看到生成了斜体字的两个文件
├── api
├── README.md
|── menu.md
└── SUMMARY.md
最后,
gitbook serve
访问XXX:4000
如图就可以查看生成的mock数据的接口文档了。