点击上方“Java基基”,选择“设为星标”
做积极的人,而不是积极废人!
每天 14:00 更新文章,每天掉亿点点头发...
源码精品专栏
smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。只需要按照java-doc标准编写注释,smart-doc就能帮你生成一个简易明了的Markdown,或是一个像GitBook样式的静态html文档、以及Postman Collection2.0+、OpenAPI 3.0+的文档。
一改传统类似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插件形式
Gradle插件形式
推荐下自己做的 Spring Cloud 的实战项目:
https://github.com/YunaiV/onemall
使用效果
源码和文档地址
源码,具体详细使用方式以及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/
欢迎加入我的知识星球,一起探讨架构,交流源码。加入方式,长按下方二维码噢:
已在知识星球更新源码解析如下:
最近更新《芋道 SpringBoot 2.X 入门》系列,已经 101 余篇,覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。
提供近 3W 行代码的 SpringBoot 示例,以及超 6W 行代码的电商微服务项目。
获取方式:点“在看”,关注公众号并回复 666 领取,更多内容陆续奉上。
文章有帮助的话,在看,转发吧。
谢谢支持哟 (*^__^*)