DOClever安装以及使用介绍

时间  2019-11-16 标签 doclever 安装 以及 使用 介绍

DOClever被赞为目前最好用的接口管理平台，强大之处在哪？试他一试。
1、什么是DOClever？
官网地址：http://doclever.cn/controller...
DOClever与目前postman、swagger不一样之处在于，不只仅能知足接口文档开发、测试、数据mock等，还更轻量级，也对postman、swagger、RAP支持导入。
注意：如下来自官网拷贝！(^▽^)javascript

DOClever是一个可视化免费开源的接口管理工具 ,能够分析接口结构，校验接口正确性， 围绕接口定义文档，经过一系列自动化工具提高咱们的协做效率。DOClever先后端所有采用了javascript来做为咱们的开发语言，前端用的是vue+element UI，后端是express+mongodb，这样的框架集成了高并发，迭代快的特色，保证系统的稳定可靠。
主要特性：

• 能够对接口信息进行编辑管理，支持 get,post,put,delete,patch 五种方法，支持 https 和 https 协议，而且支持 query，body，json，raw，rest，formdata 的参数可视化编辑。同时对 json 能够进行无限层次可视化编辑。而且，状态码，代码注入，markdown 文档等附加功能应有尽有。

• 接口调试运行，能够对参数进行加密，从 md5 到 aes 包罗万象，返回参数与模型实时分析对比，给出不一致的地方，找出接口可能出现的问题。若是你不想手写文档，那么试试接口的数据生成功能，能够对接口运行的数据一键生成文档信息。

• mock 的无缝整合，DOClever 本身就是一个 mock 服务器，当你把接口的开发状态设置成已完成，本地 mock 便会自动请求真实接口数据，不然返回事先定义好的 mock 数据。

• 支持 postman，rap，swagger 的导入，方便你作无缝迁移，同时也支持 html 文件的导出，方便你离线浏览！

• 项目版本和接口快照功能并行，你能够为一个项目定义 1.0，1.1，1.2 版本，而且能够自由的在不一样版本间切换回滚，不再怕接口信息的遗失，同时接口也有快照功能，当你接口开发到一半或者接口需求变动的时候，能够随时查看以前编辑的接口信息。

• 自动化测试功能，目前市面上相似平台的接口自动化测试大部分都是伪自动化，对于一个复杂的场景，好比获取验证码，登录，获取订单列表，获取某个特定订单详情这样一个上下文关联的一系列操做无能为力。而 DOClever 首创的自动化测试功能，只须要你编写极少许的 javascript 代码即可以在网页里完成这样一系列操做，同时，DOClever 还提供了后台定时批量执行测试用例并把结果发送到团队成员邮箱的功能，你能够及时获取接口的运行状态。

• 团队协做功能，不少相似的平台这样的功能是收费的，可是 DOClever 以为好东西须要共享出来，你能够新建一个团队，而且把团队内的成员都拉进来，给他们分组，给他们分配相关的项目以及权限，发布团队公告等等。

2、DOClever环境依赖以及使用
DOClever的使用，依赖nodejs和MongoDB，注意，这里的安装都是在windows系统上！(^▽^)
一、安装nodejs
去官网下载nodejs：https://nodejs.org/en/download/html

clipboard.png

选择windows版本64位下载，下载完成后双击msi文件安装前端

clipboard.png

clipboard.png

clipboard.png

clipboard.png

clipboard.png

clipboard.png
至此，安装完成！
win+r 输入cmdvue

clipboard.png

表示安装成功！！(^▽^)
PS：若是想配置环境变量等，能够参考此文：https://www.cnblogs.com/liuqi...java

二、安装MongoDB
去官网下载MongoDB：https://www.mongodb.com/downl...node

clipboard.png

选择windows版本64位下载，下载完成后双击msi文件安装git

clipboard.png

clipboard.png

选择自定义路径web

clipboard.png

clipboard.png

clipboard.png

clipboard.png

建立数据库文件的存放位置，在MongoDB安装目录下建立data文件夹，再建立db文件夹D:\mysoft\MongoDB\data\dbsql

win+r 输入cmdmongodb

进入MongoDB所在的bin目录下：

clipboard.png

输入命令启动MongoDB：mongod --dbpath D:\mysoft\MongoDB\data\db

clipboard.png

打开浏览器，输入 http://localhost:27017/出现如下画面表示启动成功，不成功查看端口号是否被占用。

clipboard.png

可是查看本地windows“服务”，是没有mongodb 服务的，如何配置本地windows mongodb 服务呢？(╹▽╹)

在data文件夹下建立log文件夹：D:\mysoft\MongoDB\data\db\log，用来存放日志文件

在MongoDB新建配置文件mongo.config，并在配置文件中假如如下内容：

dbpath=D:\mysoft\MongoDB\data\db
logpath=D:\mysoft\MongoDB\data\db\logmongo.log

用管理员身份运行cmd，配置windows服务

先进入到MongoDB的bin目录下，再运行命令：mongod --config "D:\mysoft\MongoDB\mongo.config" --install --serviceName "MongoDB"

clipboard.png

再次查看本地服务，发现：

clipboard.png

右击，启动服务，完成MongoDB的安装和启动。下面再安装一个MongoDB的可视化工具。

我安装的是MongoBooster，官网是：https://nosqlbooster.com/down...，须要的话能够自行下载安装。

新建数据库DOClever

clipboard.png

三、下载DOClever源码：git clone https://gitee.com/sx1989827/S...

命令窗口输入：node /web/DOClever/Server/bin/www 启动DOClever

提示输入MongoDB数据库对应地址，这里输入刚刚建立好的MongoDB对应的数据库地址

clipboard.png

提示链接成功！

接着须要输入DOClever上传文件路径，这里直接在DOClever对应文件下建立一个名为Shared文件夹

clipboard.png

clipboard.png

接着输入启动对应的端口号，这里选择的是10000

clipboard.png

出现DOClever，表示大功告成，在浏览器输入localhost:10000，打开首页

clipboard.png

注册一个帐号就可使用啦！！

选择总后台，能够查看用户项目管理等，用户名密码都是DOClever

clipboard.png

swagger文档的导入也至关简单，好比你的swagger地址为localhost:8080/swagger-ui.html

clipboard.png

clipboard.png

保存，立马OK，binggo！！

最后还有一个小问题，每次启动DOClever使用命令太麻烦，这里能够直接写一个脚本文件，用来运行。
新建文件doclever.bat文件，内容以下：

D:
cd myworkspace\DOClever\SBDoc\Server
node bin\www
pause

保存后，直接双击即启动DOClever项目。

clipboard.png

(╹▽╹)

用了以后你就停不下来，不论是页面的展现仍是功能的整合，都叫你以为眼前一亮(^▽^)

联系我们 沪ICP备13005482号-10