《Dubbo 实现原理与源码解析 —— 精品合集》 《Netty 实现原理与源码解析 —— 精品合集》
《Spring 实现原理与源码解析 —— 精品合集》 《MyBatis 实现原理与源码解析 —— 精品合集》
《Spring MVC 实现原理与源码解析 —— 精品合集》 《数据库实体设计合集》
《Spring Boot 实现原理与源码解析 —— 精品合集》 《Java 面试题 + Java 学习指南》

摘要: 原创出处 网络 「网络」欢迎转载,保留摘要,谢谢!


🙂🙂🙂关注微信公众号:【芋道源码】有福利:

  1. RocketMQ / MyCAT / Sharding-JDBC 所有源码分析文章列表
  2. RocketMQ / MyCAT / Sharding-JDBC 中文注释源码 GitHub 地址
  3. 您对于源码的疑问每条留言将得到认真回复。甚至不知道如何读源码也可以请教噢
  4. 新的源码解析文章实时收到通知。每周更新一篇左右
  5. 认真的源码交流微信群。

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开发者提供的功能。

使用形式

Maven插件形式

图片

Gradle插件形式

图片

使用效果

图片

图片

图片

图片

源码和文档地址

源码,具体详细使用方式以及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/

文章目录
  1. 1. 主要功能特性
  2. 2. 使用形式
    1. 2.1. Maven插件形式
    2. 2.2. Gradle插件形式
  3. 3. 使用效果
  4. 4. 源码和文档地址