smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要按照java标准注释编写，smart-doc就能帮你生成一个简易明了的markdown 或是一个像GitBook样式的静态html文档。如果你已经厌倦了swagger等文档工具的无数注解和强侵入污染，那请拥抱smart-doc吧！
功能特性
- 零注解、零学习成本、只需要写标准java注释。
- 基于源代码接口定义自动推导，强大的返回结构推导。
- 支持Spring MVC,Spring Boot,Spring Boot Web Flux(controller书写方式)。
- 支持Callable,Future,CompletableFuture等异步接口返回的推导。
- 支持JavaBean上的JSR303参数校验规范，支持分组验证。
- 对json请求参数的接口能够自动生成模拟json参数。
- 对一些常用字段定义能够生成有效的模拟值。
- 支持生成json返回值示例。
- 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
- 支持生成多种格式文档：Markdown、HTML5、Asciidoctor、Postman collection、Open Api 3.0+。
- 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。
- 开放文档数据，可自由实现接入文档管理系统。
- 一款代码注释检测工具，不写注释的小伙伴逃不过法眼了。
- 插件式快速集成(支持maven和gradle插件)。
- 支持Apache Dubbo rpc文档生成。
Smart-doc 和其他工具的支持
| 功能特性 | smart-doc | swagger | 非swagger生态圈工具 |
| 代码侵入 | 无 | 注解侵入性严重 | 部分工具和swagger同理，部分工具也采用源码分析 |
| 集成复杂度 | 简单，只需插件 | 偏复杂 | |
| 插件支持 | 有gradle和maven插件 | 无插件 | 基本无插件 |
| openapi规范支持 | 支持openapi 3.0 | 完全支持openapi的版本 | |
| CI构建集成 | 可在ci构建阶段使用 maven或者gradle命令 启动插件生成文档 |
不支持 | 几乎不支持 |
| 集中化文档中心集成 | 未来会独家支持集成 神秘的集中化文档管理中心， 打造自动、一体化的企业级接口文档解决方案 |
不支持 | 几乎不支持 |
| 维护持续性 | 值得信赖，开源后用户基础多，一直持续维护 | 全球用户多，开源维护值得信赖 | 维护持续性低，停更风险高 |
| mock请求 | 不支持(这并非是成熟研发团队需求) | 支持 | 未知 |
更新内容
1. 修改1.9.8启用严格检查注释模式下的bug。 2. 修改使用泛型数组参数时解析错误。 3. 修复ResponseEntity中的数组解析错误。 4. 修复controller方法标注ignore后文档序号错误。 5. 增加对@RequestMapping注解的path属性的解析支持 6. 修复postman中formdata表单不显示描述信息的问题 7. html5 allInOne模板支持代码高亮。
maven或gradle插件
smart-doc官方为了方便用户快速和无侵入的集成smart-doc的文档api生成能力，我们开发可相关的maven或者gradle插件。这里也推荐使用插件的方式来使用smart-doc。
https://gitee.com/smart-doc-team/smart-doc-maven-plugin
升级建议
修复了用户反馈的一些bug，本次升级不涉及到api的变更。
DEMO
使用demo轻松玩转接口文档生成，其他用户案例文档效果展示：https://api.doubans.com/
知名用户
- 科大讯飞
- 一加
- 小米