smart-doc是一个java restfulapi文档生成工具，smart-doc完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要写上java的标准注释，smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档和Postman json测试数据。smart-doc的理念是让你的业务接口清爽整洁。不需要像swagger一样在接口中写一堆注解。

功能特性

零注解、零学习成本、只需要写标准java注释。
基于源代码接口定义自动推导，强大的返回结构推导。
支持Spring MVC,Spring Boot,Spring Boot Web Flux(controller书写方式)。
支持Callable,Future,CompletableFuture等异步接口返回的推导。
支持JavaBean上的JSR303参数校验规范。
对json请求参数的接口能够自动生成模拟json参数。
对一些常用字段定义能够生成有效的模拟值。
支持生成json返回值示例。
支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
支持生成多种格式文档：Markdown、HTML5、Asciidoctor。
轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。
开放文档数据，可自由实现接入文档管理系统。
一款代码注释检测工具，不写注释的小伙伴逃不过法眼了。

项目仓库

smart-doc的码云仓库链接

github仓库地址链接

更新内容

修改request请求参数中嵌套对象不能解析的bug，参考gitee #I16AN2.
controller参数是数组时添加@PathVariable注解会报空指针,参考gitee #I16F6G
新增ApiDataBuilder用于获取smart-doc生成的文档数据，包含header、字典、错误码等。
修改github #9 文档错误bug.
新增接口的@author展示，方法从文档中查到找到接口负责人，生成文档可以选择关闭显示。
重点：smart-doc的maven插件smart-doc-maven-plugin 1.0.0版本发布。

smart-doc maven插件

从smart-doc 1.7.9版本开始。我们提供了smart-doc的插件smart-doc-maven-plugin。

插件使用文档

升级建议

本次推出了smart-doc-maven-plugin插件，更方便用户在maven项目中集成smart-doc生成文档，也方便在maven项目构建发布中直接使用maven命令生成项目文档。建议使用插件，通过引入插件方式，即便是不用smart-doc剔除了插件依赖也不会影响项目编译，对项目零影响。

DEMO

使用demo轻松玩转接口文档生成

smart-doc的部分用户

排名不分先后

科大讯飞
小米
一加
北京远盟健康

smart-doc 1.7.9 发布，Java 零侵入API文档生成工具