推荐一款 Java 零注解 API 文档生成工具

╰半夏微凉° 2021-09-08 10:40 406阅读 0赞

## smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具，smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 ##

smart-doc 完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要按照 java 标准注释编写，smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污染，那请拥抱 smart-doc 吧！

![null][]

## 功能特性 ##

*  支持接口 debug。
 *  零注解、零学习成本、只需要写标准 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 从 2.0.0 后几乎实现了 swagger ui 的功能，并且比 swagger ui 更简洁大方，也更符合国内开发者的诉求。当然 smart-doc 的功能也已经

超过了 swagger 为 java 开发者提供的功能。当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的，也可以将生成的 openapi 3.0 文档导入到其他ui中渲染展示。

效果图

![null][null 1]

![null][null 2]

![null][null 3]

![null][null 4]

源码：https://gitee.com/smart-doc-team

--------------------

推荐阅读

*1. *[GitHub 上有什么好玩的项目？][GitHub]

*2.  *[6 月份最热 GitHub 盘点][6 _ GitHub]

***3.***  [摸鱼王][Link 1]

*4. *[100 道 Linux 常见面试题][100 _ Linux]

![5f4655341d5a57d70940bdb22af17e81.png][]

[null]: /images/20210730/55a9a1fdca9a4805969f56c57ff1e8d4.png
[null 1]: /images/20210730/883c497fe1d64f10923ff60f573d32f3.png
[null 2]: /images/20210730/6009fdd098dd452eabc3c5b67adbe091.png
[null 3]: /images/20210730/2e67c95b4be2446ab36556f54ac41d41.png
[null 4]: /images/20210730/42fdc814775349a584787615359a9b4e.png
[GitHub]: http://mp.weixin.qq.com/s?__biz=MzUxNjg4NDEzNA%3D%3D&chksm=f9a2286fced5a1794eb9a73d0be7c2e16eaceabf3a0420647c40cb4202bd116d9a15dd57c008&idx=1&mid=2247498662&scene=21&sn=0087c4f3b79ba3420e917e9b42d45eda#wechat_redirect
[6 _ GitHub]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0e30fdf979b9ebd93a7085dc68ae3acf3efc96fd3acfa4fb8ede786ada3f3f5155986077af&idx=1&mid=2247518078&scene=21&sn=441d334c775d46831f2e6e397c317f91#wechat_redirect
[Link 1]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0e309cf979b98acabae5f66707fb10595bde93d8366e333a4b6b2a4c861af84bc29db98056&idx=1&mid=2247517983&scene=21&sn=41028ca722f05a76ea7b1abf2acca8b9#wechat_redirect
[100 _ Linux]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0e367bf979bf6dec769decc0194bb36de4caeae7947671aba1852fe6bac8e5dab7d20916a5&idx=1&mid=2247516664&scene=21&sn=0dae1a8cf99c4bde8fd8c9c197769009#wechat_redirect
[5f4655341d5a57d70940bdb22af17e81.png]: /images/20210730/9698203c186a447cbbe62631e72560a2.png