smart-doc接口文档生成工具

smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念， 完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。你只需要按照java-doc标准编写注释， smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman Collection2.0+、OpenAPI 3.0+的文档。

 

功能特点

1、零注解、零学习成本、只需要写标准JAVA注释。

2、基于源代码接口定义自动推导，强大的返回结构推导。

3、支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller书写方式)、Feign、JAX-RS。

4、支持Callable、Future、CompletableFuture等异步接口返回的推导。

5、支持JavaBean上的JSR303参数校验规范，包括分组验证。

6、对JSON请求参数的接口能够自动生成模拟JSON参数。

7、对一些常用字段定义能够生成有效的模拟值。

8、支持生成JSON返回值示例。

9、支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。

10、支持生成多种格式文档：Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。 Up- 开放文档数据，可自由实现接入文档管理系统。

11、支持导出错误码和定义在代码中的各种字典码到接口文档。

12、支持Maven、Gradle插件式轻松集成。

13、支持Apache Dubbo RPC接口文档生成。

14、debug接口调试html5页面完全支持文件上传，下载(@download tag标记下载方法)测试。

 

组合推荐

smart-doc + Torna 组成行业领先的文档生成和管理解决方案，使用smart-doc无侵入完成Java源代码分析和提取注释生成API文档，自动将文档推送到Torna企业级接口文档管理平台。

Torna是由smart-doc官方独家推动联合研发的企业级文档管理系统，因此smart-doc官方不会对接其它任何的外部文档管理系统，例如像showdoc、yapi 之类的对接请自定内部处理，也不要再给我们提其他文档系统对接的PR。我们核心是把smart-doc+Torna的这套方案打造好。

如果你需要自己构建smart-doc，那可以使用下面命令，构建需要依赖Java 1.8。

mvn clean install -Dmaven.test.skip=true