还在用 Swagger?试试这款神器,功能真心强大!

点击上方“Java基基”,选择“设为星标”

做积极的人,而不是积极废人!

每天 14:00 更新文章,每天掉亿点点头发...

源码精品专栏

 

来源:网络


smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。只需要按照java-doc标准编写注释,smart-doc就能帮你生成一个简易明了的Markdown,或是一个像GitBook样式的静态html文档、以及Postman Collection2.0+、OpenAPI 3.0+的文档。

e1b184893a83c2c4d408e623856275e0.png

一改传统类似swagger这种大量采用注解侵入来生成文档的实现方法。

主要功能特性

  • 支持接口Debug。

  • 零注解、零学习成本、只需要写标准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、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开发者提供的功能。

推荐下自己做的 Spring Boot 的实战项目:

https://github.com/YunaiV/ruoyi-vue-pro

使用形式

Maven插件形式

941c6efce689e34d5ffad251866f199f.png

Gradle插件形式

3ea6819230dce4daa6055e2781301854.png

推荐下自己做的 Spring Cloud 的实战项目:

https://github.com/YunaiV/onemall

使用效果

76cda4a5a3e84002df90c6f019054569.png

2eeb4585a2d27c7b4b950202e92e7b70.png

c16f9afdc776421851ea97d4678405ff.png

3031b8138117e4c8149729102a8a1dc6.png

源码和文档地址

源码,具体详细使用方式以及Demo可参考:https://gitee.com/smart-doc-team/smart-doc

《芋道 Spring Boot API 接口调试 IDEA HTTP Client 》:https://www.iocoder.cn/Spring-Boot/IDEA-HTTP-Client/

《芋道 Spring Boot API 接口文档 JApiDocs 入门 》:https://www.iocoder.cn/Spring-Boot/JApiDocs/

《芋道 Spring Boot API 接口文档 Swagger 入门 》:https://www.iocoder.cn/Spring-Boot/Swagger/

《芋道 Spring Boot API 接口文档 ShowDoc 入门》:http://www.iocoder.cn/Spring-Boot/ShowDoc/

《芋道 Spring Boot API 接口文档 ShowDoc 入门》:http://www.iocoder.cn/Spring-Boot/ShowDoc/



欢迎加入我的知识星球,一起探讨架构,交流源码。加入方式,长按下方二维码噢

d2ca3102254a1358d756e22617b24b88.png

已在知识星球更新源码解析如下:

3769321ace0b7c94b7210a94b949ffe6.png

2bf07ea6b7887b71938e87c20ff617a1.png

7249745137b11639db9030e0f1654959.png

9cea098486bedf21530653fd597fcf29.png

最近更新《芋道 SpringBoot 2.X 入门》系列,已经 101 余篇,覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。

提供近 3W 行代码的 SpringBoot 示例,以及超 6W 行代码的电商微服务项目。

获取方式:点“在看”,关注公众号并回复 666 领取,更多内容陆续奉上。

文章有帮助的话,在看,转发吧。
谢谢支持哟 (*^__^*)
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值