今天给大家介绍一个最近自己一直在搞的接口文档生成工具Easy-Doc，首先来说一下做这个的初衷吧。
- 首先呢，原来都是用的swagger，但是觉得代码侵入性太强了，要使用很多的注解，并且很多同事都不太想学这些注解。
- 其次返回非对象的数据无法添加注释
- 最后呢缺少一个压力测试的集成
所以我结合以上几点，开发了一款更加轻量易用的接口文档工具。
下面先来看一下效果图吧，希望大家能够喜欢！
首页
接口展开
接口详情
接口运行结果
接口返回对象
对象描述
Models描述
压力测试
接口列表
压力测试结果
全局参数
Token
是不是功能还是不错的？
整体的设计思路如下
-
本地使用
- 使用java-doc格式书写注释
- 通过正则匹配出注释
- 做渲染操作
- 返回前端页面
-
服务器jar包使用
- 使用maven或者gradle插件生成正则匹配后的源文件，然后上传到服务器
- 做渲染操作
- 返回前端页面
下面是项目在github的地址，包括前端(React)，Maven(Java)，Gradle(Groovy)，Core(Java-Web)。
项目图
网友评论