smart-doc 是一个 java restful api 文档生成工具，smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要按照java标准注释的写，smart-doc 就能帮你生成一个简易明了的 Markdown、Html、AsciiDoc 文档。
如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污染，那请拥抱 smart-doc吧！喜欢 smart-doc 的用户也不要忘记给项目 star，你们的支持是 smart-doc 持续推进的动力。
功能特性
- 零注解、零学习成本、只需要写标准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 vs Swagger
- smart-doc 不是对 Swagger 造轮子，这是一款用完全不同的理念重新开发的 restful api 接口文档生成工具。
- smart-doc 比 swagger 集成更简单，可以自由生成多种格式的 api 文档。
- smart-doc 完全不需要在侵入到业务代码中写任何注解，复杂嵌套对象自动推导出定义字段结构。
- smart-doc 代码量很少，如果不能满足你的需求完全可以自己修改源码定制(当前有数十家企业基于smart-doc强大的源码分析能力做二次修改内部使用)。
更新内容
- 修改timestamp类型字段创建json示例错误bug。
- fix #I1545A 单接口多路径bug。
- 修改部分url生成部署空格问题。
- 优化对java.util.concurrent.ConcurrentMap的解析。
DEMO
使用 demo 只有smart-doc能够自己分析出完善文档的demo
相关文档
用户评价
部分使用者对 smart-doc 的评价
- 最强大的 doc 组件，强制要求了规范，也不会污染代码，欣喜之情溢于言表!
- smartdoc 从注释入手，即规范强化了文档的编写又能提供源码文档之外的 api 功能，真的对得起 smart 的称谓。
Smart-doc用户
很多人看到smart-doc会问，有人用吗？目前有数十家企业因为代码风格和自定义注解问题不能满足，他们基于smart-doc做定制修改内部使用。有几十家企业直接使用smart-doc生成内部接口对接文档。我们最近的新版本发布修复的bug都来自用户的反馈，这些反馈信息来自技术交流群、issues和邮件。很多用户之所以选择smart-doc，不是因为smart-doc做的有多好，而是其它工具要么侵入性强，要么源码解析能力太弱无法分析大多数公司的源代码给出可用的文档。