DOClever安装及试用

一、背景

DOClever首页：http://doclever.cn/controller/index/index.html

1. DOClever是什么

• 是一个可视化免费开源的接口管理工具
• 可以分析接口结构，校验接口正确性， 围绕接口定义文档，通过一系列自动化工具提升我们的协作效率
• 前后端全部采用了javascript来作为开发语言，前端用的是vue+element UI，后端是express+mongodb

2. DOClever有哪些特性

1. 可以对接口信息进行编辑管理
   1. 支持 get,post,put,delete,patch 五种方法
   2. 支持 https 和 https 协议
   3. 支持 query，body，json，raw，rest，formdata 的参数可视化编辑
   4. 对 json 可以进行无限层次可视化编辑
   5. 支持状态码，代码注入，markdown 文档等附加功能
2. 接口调试运行
   1. 可以对参数进行加密，从 md5 到 aes 一应俱全
   2. 返回参数与模型实时分析对比，给出不一致的地方，找出接口可能出现的问题
   3. 接口的数据生成功能，可以对接口运行的数据一键生成文档信息
3. mock 的无缝整合
   1. 自身就是一个 mock 服务器，把接口的开发状态设置成已完成，本地 mock 便会自动请求真实接口数据
   2. 否则返回事先定义好的 mock 数据
4. 支持各种类型文件的导入导出
   1. 支持 postman，rap，swagger 的导入
   2. 支持 html 文件的导出
5. 项目版本和接口快照功能并行
   1. 可以为一个项目定义 1.0，1.1，1.2 版本，并且可以自由的在不同版本间切换回滚
   2. 接口也有快照功能，当你接口开发到一半或者接口需求变更的时候，可以随时查看之前编辑的接口信息。
6. 自动化测试功能
   1. 编写极少量的 javascript 代码便可以在网页里完成这样一系列业务流程操作
   2. 提供了后台定时批量执行测试用例并把结果发送到团队成员邮箱的功能
7. 团队协作功能
   1. 可以新建一个团队，并且把团队内的成员都拉进来
   2. 支持分组，支持分配相关的项目以及权限
   3. 支持发布团队公告

二、安装

1. 安装node

• Windows：下载8.X最新版本并安装，https://nodejs.org/dist/latest-v8.x/，一路下一步，最后确认安装即可，没有什么需要特别注意的地方

　　安装完成后，启动命令行输入node -v，看到版本号说明安装成功

2. 安装mongodb

• Windows：下载自己平台对应的版本并安装，https://www.mongodb.com/download-center/community，一路Next即可
  • 安装完成后，将mongo的bin目录添加到系统path中
  • 验证安装成功，启动命令行，输入mongo --version，可以看到mongo版本信息
• Linux：待完成..

3. 安装mongodb管理工具

• Windows：选在自己平台对应的版本并安装，https://robomongo.org/download

　　安装完成后，启动后新建数据库连接

　　

　　确认后，在列表中打开，即可

　　

4. 新建数据库

 　　新建数据库

　　

　　名称随意，如doclever

　　

　　确认后，可以看到数据库已经成功创建

　　

 5. 部署

1. 克隆DOClever代码到本地：git clone [email protected]:sx1989827/SBDoc.git
2. 进入到doclever\Server\bin，运行node www进行一系列配置

　　

6. 验证安装

　　在浏览器中访问：http://localhost:20000

　　后台管理员的账号和密码都是：DOClever

　　注册一个账号登录后即可进行操作

三、使用