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. 修改request请求参数中嵌套对象不能解析的bug,参考gitee #I16AN2. 2. controller参数是数组时添加@PathVariable注解会报空指针,参考gitee #I16F6G 3. 新增ApiDataBuilder用于获取smart-doc生成的文档数据,包含header、字典、错误码等。 4. 修改github #9 文档错误bug. 5. 新增接口的@author展示,方法从文档中查到找到接口负责人,生成文档可以选择关闭显示。 6. 重点:smart-doc的maven插件smart-doc-maven-plugin 1.0.0版本发布。
从smart-doc 1.7.9版本开始。我们提供了smart-doc的插件smart-doc-maven-plugin。
插件使用文档
本次推出了smart-doc-maven-plugin插件,更方便用户在maven项目中集成smart-doc生成文档,也方便在maven项目构建发布中直接使用maven命令
生成项目文档。建议使用插件,通过引入插件方式,即便是不用smart-doc剔除了插件依赖也不会影响项目编译,对项目零影响。
使用demo 轻松玩转接口文档生成
smart-doc文档wiki