api文档 smart-doc (可以结合idea的自定义注释一起使用更方便)

1 篇文章 0 订阅
1 篇文章 0 订阅

官方说明:smart-doc是一个java restful api文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写,smart-doc就能帮你生成一个简易明了的markdown 或是一个像GitBook样式的静态html文档。如果你已经厌倦了swagger等文档工具的无数注解和强侵入污染,那请拥抱smart-doc吧!

之前一直在使用swagger做联调,老大说这个东西太重,而且入侵代码太强了,然后就找到了smart-doc,根据官方文档做了个demo,这个还可以导出一个json格式的文件,完美契合postman,可以直接导入postman进行测试,感觉挺好用,然后就结合idea的自定义注释做一个。下面是相关资料了。

smart-doc文档地址:“https://gitee.com/sunyurepository/smart-doc/wikis/%E5%8D%95%E5%85%83%E6%B5%8B%E8%AF%95%E9%9B%86%E6%88%90smart-doc?sort_id=1990284

idea自定义注释:“IDEA类和方法注释模板设置(非常详细)_吃货刘小念的博客-CSDN博客_idea注释模板

参数设置:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(i == 0) result += '* @param ' + params[i] + ' ' + ((i < params.size() - 1) ? '\\n' : '');else result+=' * @param ' + params[i] + ' ' + ((i < params.size() - 1) ? '\\n' : '')}; if(result=='* @param  ' || result=='* @param null ') return '' else return '\\n '+result", methodParameters())
return设置:
groovyScript("def result=\"${_1}\".replaceAll('[\\\\|\\\\s]', ''); if(result=='void'||result=='null') return '' else return '\\n * @return '+result", methodReturnType())

*
 * $description$
 * $end$
 * @author ghc
 * @since $date$ $time$ $param$ $return$
 */

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值