smart-doc是一个java restful api文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档。如果你已经厌倦了swagger等文档工具的无数注解和强侵入污染,那请拥抱smart-doc吧!喜欢smart-doc的用户也不要忘记给项目star,你们的支持是smart-doc持续推进的动力。
Smart-doc vs Swagger
1. 优化注释换行/n/r问题,依赖common-util 1.8.7。 2. 修改gitee上bug #I135PG。 3. 添加@requestHeader注解的支持,文档自定将参数绑定到请求头列表中。 4. 增加javadoc apiNote tag的支持。 5. 解决扫描分析controller中private方法的问题。 6. 添加支持@RequestParam注解重写参数名和设置默认值的文档解析。 7. 新增对Spring ResponseEntity的解析。 8. 增加内部类结构解析。 9. 修改文档中显示的字段类型,float、double等由原来的number直接变成具体类型。
这个版本相对之前的版本做了很多推导优化和功能更新,增加很多用户期待的书签式html格式Api文档,强烈建议升级到最新版本。
使用demo 轻松玩转接口文档生成
关于java web restful api文档的重新探索
smart-doc功能使用介绍
项目wiki