DOClever简介:
DOClever是一个可视化接口管理工具 ,可以分析接口结构,校验接口正确性, 围绕接口定义文档,通过一系列自动化工具提升我们的协作效率。
DOClever官网:http://www.doclever.cn/controller/index/index.html
DOClever GitHub:https://github.com/sx1989827/DOClever
为什么使用DOClever?
接口管理平台还有很多,比如eolinker(收费)、 阿里rap2(部署略麻烦)、 Apizza(感觉就是中文版的postman )SHOWDOC(没看到有测试功能)、YApi (还不错,简单试用了下)。
每款软件都不是十全十美的,目前也没哪款软件做到完全满足我们的各种使用需求。作为后端开发人员,最主要的需求就是它能自动生成接口文档,方便跟前端联调,以及方便后端自测,其实postman和swagger用着就已经很好了。
如果是团队使用,我比较推荐阿里的rap2和DOClever,由于DOClever安装、部署、使用起来比较简单。
DOClever有哪些特性
- 可以对接口信息进行编辑管理
- 支持 get,post,put,delete,patch 五种方法
- 支持 https 和 https 协议
- 支持 query,body,json,raw,rest,formdata 的参数可视化编辑
- 对 json 可以进行无限层次可视化编辑
- 支持状态码,代码注入,markdown 文档等附加功能
- 接口调试运行
可以对参数进行加密,从 md5 到 aes 一应俱全
返回参数与模型实时分析对比,给出不一致的地方,找出接口可能出现的问题
接口的数据生成功能,可以对接口运行的数据一键生成文档信息
mock 的无缝整合
自身就是一个 mock 服务器,把接口的开发状态设置成已完成,本地 mock 便会自动请求真实接口数据
否则返回事先定义好的 mock 数据
支持各种类型文件的导入导出
支持 postman,rap,swagger 的导入
支持 html 文件的导出
项目版本和接口快照功能并行
可以为一个项目定义 1.0,1.1,1.2 版本,并且可以自由的在不同版本间切换回滚
接口也有快照功能,当你接口开发到一半或者接口需求变更的时候,可以随时查看之前编辑的接口信息。
自动化测试功能
编写极少量的 javascript 代码便可以在网页里完成这样一系列业务流程操作
提供了后台定时批量执行测试用例并把结果发送到团队成员邮箱的功能
团队协作功能
可以新建一个团队,并且把团队内的成员都拉进来
支持分组,支持分配相关的项目以及权限
支持发布团队公告
安装使用:
win10,node.js、mongodb(64位下载库)、Robo 3T 下载安装最新的就行(node.js建议安装LTS版本),安装教程网上一大堆,只用安装好就行。然后新建一个名称为“DOClever”的数据库(详见文末参考文章)。
把DOClever从GitHub上down到本地
down下来之后就是这样子的:
部署
进入到D:\DOClever\Server\bin,运行node www进行一系列配置
在浏览器中访问:http://localhost:10000(10000就是上一步配置的端口号)
后台管理员的账号和密码都是:DOClever
注册一个账号登录后即可进行操作
开始DOCLever
- 可视化的管理API
- 界面左侧树形图式管理所有相关API,方便查找
- 可视化界面直接填写API相关信息
- 参数化填写request请求体
- 参数化编写响应数据,支持无限层次嵌套
方便的Mock数据获取
- 直接选择DOClever自带的mock服务器,可以方便地与协作人员沟通接口字段和结构
- 选择自己搭建的Mock服务器,可以方便地获得更多模式相同的响应数据
自动化接口测试
- 简易的自动化测试语法
自动化测试集计划任务
- 定时跑任务自动化测试用例集
关注公众号 soft张三丰