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

功能特性

• 支持生成可直接调试接口的文档页面(文件上传、下载也支持)。


• 零注解、零学习成本、只需要写标准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 2.0+、Open Api 3.0 +。


• 轻易实现在Spring Boot服务上在线查看静态HTML5文档，支持debug调试接口。


• 开放文档数据，可自由实现接入文档管理系统。


• 支持生成Postman Collection数据一键到入到Postman测试接口，参数值默认帮你填好。


• 从1.8.0版本全面支持json和表单请求解析。

• 一款代码注释检测工具，不写注释的小伙伴逃不过法眼了。


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


• Maven、Gradle插件化支持，使用极其简单（推荐使用插件）。


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


• JAX-RS支持

官方推荐方案

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

smart-doc+Torna文档自动化

知名用户

• 一加【oneplus】




• 科大讯飞




• 小米




• 同程旅行




• 马蜂窝




• 东软




• 汉得信息

Markdown工具推荐

      smart-doc目前能够支持将文档合并到一个Markdown文件，因此你可以使用Typora工具将Markdown转换成pdf、word或者是html文档。

相关文档

smart-doc官方wiki：https://gitee.com/smart-doc-team/smart-doc/wikis/Home

Demo

demo地址：https://gitee.com/smart-doc-team/smart-doc-example-cn.git