Smart-Doc Project

Introduce

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

$\color{red}{你给我的star，胜过所有读过的诗—smart-doc}$

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

查看快速开始 了解详情

Features

• 零注解、零学习成本、只需要写标准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接口文档生成。
• 支持基于Git管理项目的变更增量文档生成。
• debug接口调试html5页面完全支持文件上传，下载(@download tag标记下载方法)测试。

Best Practice

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

smart-doc+Torna文档自动化

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

Building

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

mvn clean install -Dmaven.test.skip=true

TODO

• GRPC

License

smart-doc is under the Apache 2.0 license. See the LICENSE file for details.

注意： smart-doc源代码文件全部带有版权注释，使用关键代码二次开源请保留原始版权，否则后果自负！

Who is using

排名不分先后，更多接入公司，欢迎在https://gitee.com/smart-doc-team/smart-doc/issues/I1594T 登记（仅供开源用户参考）

Award situation

• 2020 年度 OSC 中国开源项目评选”活动中获得「最积极运营项目」

Acknowledgements

感谢JetBrains SoftWare 免费的开源授权。

Contact

愿意参与构建smart-doc或者是需要交流问题可以扫描微信二维码发送smart-doc备注信息后管理园拉进群，常见问题答疑

1群已满，有问题请加2群。