smart-doc Java 零注解侵入 API 文档工具 2.2.4 发布
smartdoc647 · 2021-08-10 10:00:02 +08:00 · 1907 次点击这是一个创建于 1226 天前的主题，其中的信息可能已经有所发展或是发生改变。
smart-doc 经历了三年的发展，已经得到了行业内许多开发团队的认可。如科大讯飞、小米、顺丰内部都有部分团队在采用 smart-doc 来生成 API 文档。
功能特性
- 零注解、零学习成本、只需要写标准 java 注释。
- 基于源代码接口定义自动推导，强大的返回结构推导。
- 支持 Spring MVC,Spring Boot,Spring Boot Web Flux(controller 书写方式)。
- 支持 Callable,Future,CompletableFuture 等异步接口返回的推导。
- 支持 JavaBean 上的 JSR303 参数校验规范，支持分组验证。
- 对 json 请求参数的接口能够自动生成模拟 json 参数。
- 支持生成 json 返回值示例。
- 支持从项目外部加载源代码来生成字段注释。
- 支持生成多种格式文档：Markdown 、HTML5 、Postman collection 。
- 插件式快速集成(maven 、gradle)。
- 拥有完整的从文档生成到企业级文档管理的方案(smart-doc+torna 可以类比为 yapi 的插件和 yapi,但是比 yapi 整体处理能力更强)，torna 基于 SpringBoot 完成开发很方便企业去做二次开发。
项目仓库
未来新功能
- 根据 API 接口生成 jemeter 性能测试脚本。
- JAX-RS 标准支持，支持更多的框架，如：Quarkus 、Dubbo Rest 。(开发已经完成，进入测试阶段)
 |
1
v2orz 2021-08-11 10:12:47 +08:00
感觉挺有意思，在自己项目尝试了几个
识别能力有待加强，有自定义注解的字段好多都解析不到注释 JSR303 如果在 set 方法上貌似也有问题？ |
|
2
v2orz 2021-08-11 10:13:26 +08:00
总的来说很感兴趣，感谢你们的工作
|
 |
3
122006 2021-08-11 19:02:35 +08:00
其实这种功能最好还是通过 idea 插件遍历 psi 元素来实现，真正做到 0 侵入
难度也差不多 |
 |
4
guyeu 2021-08-14 10:45:16 +08:00
非 spring boot 或者 dubbo 项目，能支持吗
|
 |
5
smartdoc647 OP @v2orz 自定义注解肯定不属于我的支持的范畴，注解属性就很宽泛，都是有一定框架使用范围的。开源一般只做一些标准框架支持
|
|
6
v2orz 2021-08-19 13:58:36 +08:00
|
|
7
smartdoc647 OP @v2orz 有问题可以提 issue 的，附带导致错误的用例就可以，毕竟要面向很多写法。都是不断迭代修复
|
Select Language