mock2easy环境搭建和gitbook文档自动生成

第一步

先在服务器上准备node环境
yum -y install gcc make gcc-c++ openssl-devel wget
下载源码及解压:
wget http://nodejs.org/dist/v0.10.26/node-v0.10.26.tar.gz
tar -zvxf node-v0.10.26.tar.gz
编译及安装:
make && make install
验证是否安装配置成功:
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
安装完成之后
vim .roadhogrc.mock.js
覆盖代码如下

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);
  });
});

vim .roadhogrc
加入如下代码

"proxy": {
      "/api": {
          "target": "http://localhost:8006",
          "changeOrigin": true,
          "secure": false,
          "pathRewrite": { "^/api" : "" }
      }
    }

重启服务然后访问
XXX:8006
如图这里写图片描述

至此mock2easy的接口模拟环境就搭建好了

第四步

gitbook文档自动生成(这个功能只能生成之后手工启动服务,希望大家一起完善)
gitbook 安装
npm install -g gitbook-cli

gitbook -V
查看gitbook是否安装成功。

然后找到上面的mock2easy的项目地址,然后进入doc
文件夹下面执行
gitbook init
然后执行tree
.
├── api
├── menu.md
├── README.md
└── SUMMARY.md

可以看到生成了斜体字的两个文件

vim SUMMARY.md

gitbook serve
访问XXX:4000
这里写图片描述
如图就可以查看生成的mock数据的接口文档了

gitbook的更多操作可以参考gitbook

注:由于本人不是本方面的专业人才,暂时还没有找到从mock2easy 自动生成文档之后不需要重启gitbook服务就能直接刷新数据的方法
提供一个思路:mock2esay 的生成文件部分的代码重构下,生成gitbook的指定位置应该可以(或者生成之后可以自动重启gitbook),这个还有待研究

<script type="text/javascript"> $(function () { $('pre.prettyprint code').each(function () { var lines = $(this).text().split('\n').length; var $numbering = $('<ul/>').addClass('pre-numbering').hide(); $(this).addClass('has-numbering').parent().append($numbering); for (i = 1; i <= lines; i++) { $numbering.append($('<li/>').text(i)); }; $numbering.fadeIn(1700); }); }); </script>
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值