smart-doc 是一款同时支持 java restful 和 apache dubbo rpc 接口文档生成的工具，smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。smart-doc 完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要按照 java 标准注释编写，smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污染，那请拥抱 smart-doc 吧！
功能特性
- 零注解、零学习成本、只需要写标准 java 注释。
- 基于源代码接口定义自动推导，强大的返回结构推导。
- 支持 Spring MVC,Spring Boot,Spring Boot Web Flux(controller 书写方式)。
- 支持 Callable,Future,CompletableFuture 等异步接口返回的推导。
- 支持 JavaBean 上的 JSR303 参数校验规范，支持分组验证。
- 对 json 请求参数的接口能够自动生成模拟 json 参数。
- 支持生成 json 返回值示例。
- 支持从项目外部加载源代码来生成字段注释。
- 支持生成多种格式文档：Markdown 、HTML5 、Postman collection 。
- 插件式快速集成，文档齐全，官方提供了 21 个文档。
- 支持 apache dubbo rpc
项目仓库
smart-doc 的部分知名用户
- 科大讯飞
- 小米
- 一加
提醒
Apache Dubbo RPC接口的文档在smart-doc 1.8.7版本中提供，已发布仓库。当前未在仓库中查到的请耐心等待。
