今天給大家介紹一個最近自己一直在搞的接口文檔生成工具Easy-Doc甚牲，首先來說一下做這個的初衷吧彰居。
- 首先呢要销，原來都是用的swagger，但是覺得代碼侵入性太強了嘉熊，要使用很多的注解遥赚，并且很多同事都不太想學這些注解。
- 其次返回非對象的數(shù)據(jù)無法添加注釋
- 最后呢缺少一個壓力測試的集成
所以我結(jié)合以上幾點阐肤，開發(fā)了一款更加輕量易用的接口文檔工具凫佛。
下面先來看一下效果圖吧，希望大家能夠喜歡孕惜！
首頁
接口展開
接口詳情
接口運行結(jié)果
接口返回對象
對象描述
Models描述
壓力測試
接口列表
壓力測試結(jié)果
全局參數(shù)
Token
是不是功能還是不錯的愧薛？
整體的設計思路如下
-
本地使用
- 使用java-doc格式書寫注釋
- 通過正則匹配出注釋
- 做渲染操作
- 返回前端頁面
-
服務器jar包使用
- 使用maven或者gradle插件生成正則匹配后的源文件，然后上傳到服務器
- 做渲染操作
- 返回前端頁面
下面是項目在github的地址衫画，包括前端(React)毫炉，Maven(Java)，Gradle(Groovy)削罩，Core(Java-Web)瞄勾。
項目圖
