Smart-Doc 是什么？

Badge	Image
Maven Version
License
Number of Closed Issues
Closed Pull Requests
Java Version
Gitee Star
GitHub Star

smart-doc是一款支持JAVA REST API、JAVA WebSocket、Apache Dubbo RPC和gRPC接口文档生成的工具。

概述

smart-doc[/smɑːt dɒk/]率先提出了基于Java泛型定义来推导接口文档的概念。它完全依赖于接口的源代码进行分析和生成文档，无需在业务代码中添加任何注解。只需按照JavaDoc的标准编写注释，smart-doc就能够帮助您生成简洁明了的Markdown、HTML5、Postman Collection 2.0+ 和 OpenAPI 3.0+ 格式的文档。

无论你是很有经验的大佬、还是刚入行的萌新。遇到使用疑惑时，我们希望你能仔细阅读smart-doc官方文档。我们将smart-doc及其插件的每一个配置项和可能在日常中遇到的问题都整理到了文档中。仔细阅读文档就是对开源项目最大的支持。

查看快速开始了解详情。

特性

零注解、零学习成本、只需要写标准JAVA注释。
基于源代码接口定义自动推导，强大的返回结构推导。
支持Spring MVC、Spring Boot、Spring Boot Web Flux(Controller书写方式)、Feign。
支持Callable、Future、CompletableFuture等异步接口返回的推导。
支持JavaBean上的JSR303参数校验规范，包括分组验证。
对JSON请求参数的接口能够自动生成模拟JSON参数。
对一些常用字段定义能够生成有效的模拟值。
支持生成JSON返回值示例。
支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
支持生成多种格式文档：Markdown、HTML5、Word、Asciidoctor、Postman Collection、OpenAPI 3.0。开放文档数据，可自由实现接入文档管理系统。
支持导出错误码和定义在代码中的各种字典码到接口文档。
支持生成JMeter性能测试脚本。
支持Maven、Gradle插件式轻松集成。
支持Apache Dubbo RPC接口文档生成。
支持gRPC接口文档生成。
支持Java WebSocket接口文档生成。
支持普通Java类生成javadoc文档。
支持基于Git管理项目的变更增量文档生成。
debug接口调试html5页面完全支持文件上传，下载(@download tag标记下载方法)测试。