一款零注解侵入的 API 文档生成工具，你用过吗？

╰+攻爆jí腚メ 2022-10-09 00:52 205阅读 0赞

![b34eddde134212d77a829bacd0fe6b0b.png][]

## 介绍 ##

smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念，完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。

你只需要按照java-doc标准编写注释， smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman、Collection2.0+、OpenAPI 3.0+的文档。

## 特点 ##

*  零注解、零学习成本、只需要写标准JAVA注释。
 *  基于源代码接口定义自动推导，强大的返回结构推导。
 *  支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller书写方式)、Feign。
 *  支持Callable、Future、CompletableFuture等异步接口返回的推导。
 *  支持JavaBean上的JSR303参数校验规范，包括分组验证。
 *  对JSON请求参数的接口能够自动生成模拟JSON参数。
 *  对一些常用字段定义能够生成有效的模拟值。
 *  支持生成JSON返回值示例。
 *  支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
 *  支持生成多种格式文档：Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。Up- 开放文档数据，可自由实现接入文档管理系统。
 *  支持导出错误码和定义在代码中的各种字典码到接口文档。
 *  支持Maven、Gradle插件式轻松集成。
 *  支持Apache Dubbo RPC接口文档生成。
 *  debug接口调试html5页面完全支持文件上传，下载(@download tag标记下载方法)测试。

Smart-doc 从 2.0.0 后几乎实现了 swagger ui 的功能，并且比 swagger ui 更简洁大方，也更符合国内开发者的诉求。

当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的，也可以将生成的 openapi 3.0 文档导入到其他ui中渲染展示。另外，欢迎关注公众号Java笔记虾，后台回复“后端面试”，送你一份面试题宝典！

## 效果示例 ##

##### 1.1 接口文档效果图 #####

![1.png][] 输入图片说明 ![1.png][1.png 1] 请求参数示例 [![1.png][1.png 2]][1.png_1.png 2] 响应参数示例

###### 1.2 html全局效果 ######

![example.png][] html文档

> 更多了解，开源地址：https://gitee.com/smart-doc-team

推荐好文

[强大，10k+点赞的 SpringBoot 后台管理系统竟然出了详细教程！][10k_ SpringBoot]

[分享一套基于SpringBoot和Vue的企业级中后台开源项目，代码很规范！][SpringBoot_Vue]

[能挣钱的，开源 SpringBoot 商城系统，功能超全，超漂亮][SpringBoot]![b9ace19cb8fade04639162aff716add8.png][]

[b34eddde134212d77a829bacd0fe6b0b.png]: /images/20221005/4fe0930b1a474a2ea8e7e22f75241e49.png
[1.png]: /images/20221005/5191896b24764440a8b188c513cc29d6.png
[1.png 1]: https://img-blog.csdnimg.cn/img_convert/65a2e86a96994664924e54638cc21c98.png
[1.png 2]: https://img-blog.csdnimg.cn/img_convert/2923024a7546de5180213b3e9c1632f7.png
[1.png_1.png 2]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc798b9ecb0e0288697af194f241f3c3da73381f69116f72db3a0fdf92b6aa4e19dd3c5c285d&idx=3&mid=2247493168&scene=21&sn=4a2eb3c0ad574dd58bda8664746aae00#wechat_redirect
[example.png]: /images/20221005/b38ed596472f42879edef84d9f9b82b4.png
[10k_ SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzI4Njc5NjM1NQ%3D%3D&chksm=ebd5c411dca24d07446a4f22772cd12d2cc1143b62eb922a14500ae981cd57fb850ef74ca257&idx=2&mid=2247498557&scene=21&sn=84902d7030e174e152615d8fae3755cc#wechat_redirect
[SpringBoot_Vue]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799be6cb0e12f0b58479f8b031bc5ae79efdca1880ff9b19f0a107c3a88c37b9596dc73203&idx=2&mid=2247497288&scene=21&sn=65d7111a19e920df1e9416959594b2f4#wechat_redirect
[SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799a9ccb0e138a64a2671f31b8d4be1b3c061a288f7b0d1d4af02a60c45a72231446b91e00&idx=2&mid=2247497522&scene=21&sn=c5b4e596be4ac7d7f293e7e2f0ea0769#wechat_redirect
[b9ace19cb8fade04639162aff716add8.png]: /images/20221005/fb7aa686e6264e56a1c57b1f49ed163f.png