SBDoc 接口管理和自动化测试内网配置和 mac 搭建局域网
公司开发项目一直没有用接口管理工具,接口文档也是使用 word 文档,协同开发起来很麻烦.我在网上也找了其他的接口管理的工具,但是很多接口管理工具的数据都是在他们自己的服务器上.考虑接口文档的安全性所以只能找开源的工具然后部署到自己的服务器上,然后就了解到了 SBDoc.
简单介绍一下 SBDoc, 作者是计划(不知道是不是真名,感觉是一个有故事的大神 详细介绍 )SBDoc 不仅集成了文档编写,团队协作,接口运行,mock 数据等功能,还有两个功能是让我们团队大大的提高工作效率的.一个是接口的自动化生成,可以根据接口数据自动生成文档信息,还有一个便是接口的自动化测试!附上 SBDoc 线上版本
今天我给大家介绍的是关于内网配置(mac).
1. 首先本地要安装 node 环境,推荐 6.10.0 版本 ( 下载页面 )
2. 安装 mongodb( 下载页面 ),可使用 robomongo 来作为 mongodb 的客户端工具 ( 下载页面 ).这里不推荐大家直接下载安装,最好使用终端安装, 附上终端安装教程 ,安装完成后需要开启.终端安装 mongodb 需要通过 homebrew 来安装 ( 附上安装教程 ) .
下载 robomongo 后点击安装,安装完成后还会出现以下界面(当然没有创建数据库的话是不会有 test 那个项目的,那是我创建过的)
点击创建后的界面 (test 是我之前创建的,正常第一次打开是什么都没有的).
点击 Create 后进入创建页面,输入数据库名称,其他使用默认设置即可,点击 Save.
返回上一级页面点击继续,会创建成功.
3. 将 SBDoc 的源码 down 到本地,进入根目录,修改 config.json
{
"db":"mongodb://localhost:27017/SBDoc", // 这里为你的 mongodb 服务器的地址和库的名称
"filePath":"/Users/Shared/SBDoc", // 这里作为 SBDoc 文件上传的路径
"imgPath":"/Users/Shared/SBDoc/img", // 这里是 SBDoc 图片上传的路径 (是 SBDoc 文件上传的路径的直接子目录)
"tempPath":"/Users/Shared/SBDoc/temp", // 这里 SBDoc 临时文件上传的路径(是 SBDoc 文件上传的路径的直接子目录)
"port":10000, //SBDoc 启动的端口号
"version":"1.0.0" //SBDoc 的版本号(无需修改)
}
给你们附上我的 config.json
{
"db": "mongodb://localhost:27017/test",
"filePath": "/Users/liangqianyong/desktop/SBDoc",
"imgPath": "/Users/liangqianyong/desktop/SBDoc/img",
"tempPath": "/Users/liangqianyong/desktop/SBDoc/temp",
"port": 10000,
"version": "2.1.2"
}
需要注意的是 filePath,imgPath,tempPath 需要是真实存在的路径.
4. 在命令行下运行 node SBDoc 的根目录 / SBDoc/bin/www 即可启动 SBDoc(如果是 windows 环境下,请修改目录分隔符),在浏览器里输入 localhost:SBDoc 启动的端口号, 出现首页表示部署成功.附上我的路径示例:/Users/liangqianyong/Downloads/SBDoc-master/SBDoc/bin/www
以上所有的本地环境都搭建好了,现在在浏览器输入 localhost: 你的端口号会出现首页,如果没有出现请自行对照步骤排查.
下面是搭建局域网
macbook 上没有网线插口,所以需要一个雷电以太网转接器或者是 usb 以太网转接器,能够保证电脑联网.详细教程请戳 构建局域网 .
以上步骤完成后,使用同一路由器的电脑或者是连接你的服务器电脑热点的电脑都可通过服务器电脑的 ip: 端口号访问主页.
在说明一下,每次电脑重启后都需要重新打开 mongodb 后运行 node SBDoc 的根目录 / SBDoc/bin/www 即启动 SBDoc.
github:https://github.com/sx1989827/SBDoc
该教程多是把网上的教程做了个统一,方便查阅.SBDoc 交流群:611940610 我的 QQ:929245885 有什么不足欢迎指出.
来源: http://www.jianshu.com/p/c19d0bc71d69