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

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

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

功能特性

• 支持接口 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中渲染展示。

效果图

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

---

推荐阅读

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

2.  6 月份最热 GitHub 盘点

3.  摸鱼王

4. 100 道 Linux 常见面试题