简介和愿景
smart-doc 是一个为 Java 开发者提供的一款强大的文档生成工具,也是国内最早实现利用 Javadoc 注释和范型推导生成文档的工具。它可以帮助开发者快速、高效地生成 API 文档。我们的目标是让开发者能够更专注于代码的编写,而不是文档的编写。我们相信,通过我们的努力,我们可以为 Java 开发者提供一个更好的开发环境。
更新内容
在这个版本中,我们修复了众多 bug:
- 修复 Java 16+版本反射获取字段是 jdk 中的类时异常。 #615
- 修复枚举字典显示错乱问题,维持代码中编写的顺序。#603
- 支持获取接口的注释,#573
- 生成 html 页面支持多文件上传。#594
- 无参请求生成时生成的 OpenAPI 文档错误。#616
- 扫描文档时丢弃对 JDK 原生类型的反射,避免高版本 JDK 反射时报错。pr#621
- 修复生成 postman collection 后导入到 postman 缺少 file 文件参数问题。#622
- 修复配置 ResponseBodyAdvice 后 torna 推送数据错误问题。#599
- 修复 customResponseFields 无法忽略字段的 bug 。 #625
- 修复请求参数标记 @Null 注解时字段没被忽略的 bug 。#608
项目地址
GitHub: https://github.com/TongchengOpenSource/smart-doc
不要忘记点个 star 哦, 您给的 star ,胜过人间的诗!
项目用户
smart-doc 目前已经成为国内除 swagger 外被使用量最高接口文档生成工具。百度引擎搜索结果高达 1100W+。
知名用户:
- 科大讯飞
- 小米
- 顺丰
- 同程
- 马蜂窝
参与共建
欢迎感兴趣的同学参与社区共建,社区参与指南: https://smart-doc-group.github.io/#/zh-cn/community/developer