smart-doc 是一款同时反对 JAVA REST API 和 Apache Dubbo RPC 接口文档生成的工具，smart-doc 利用接口泛型和 javadoc 正文主动剖析生成 api 接口文档，不采纳任何注解侵入到业务代码中。只须要在我的项目中引入 smart-doc 提供的 maven 或者是 gradle 插件，而后依照标准写好 javadoc 正文即可生成 api 文档。同时 smart-doc 也反对生成 openapi 和 postman 这些标准的文档，生成后能够间接导入相干工具做测试。
目前在国内已被小米、科大讯飞、同程旅行、快手、马蜂窝、顺丰等出名公司所应用。
仓库地址
https://github.com/TongchengOpenSource/smart-doc
重要更新内容
- 反对分批上传文档到 torna#697
- 反对提取 java record 的正文 #703
- 重构优化 word 模版，也是行业内首次在 word 上实现了 markdown 原样的文档，生成的文档更丑陋 #710
- 反对 @JsonSerialize(using = ToStringSerializer.class) 字段类型的解决。#715
- 优化常量获取，兼容更多用户能够在门路中应用各种常量。#730
本次社区共计合并的 pr 20+，修复了多个 bug, 更多更新内容请查看 https://github.com/TongchengOpenSource/smart-doc/releases/tag/3.0.2
新增贡献者
- @bugDesigner1
- @WingGao
- @SteinsGate1097302
- @linwumingshi
- @Mr-lijx
- @LabelZhou
- @baboy
本次更新新增 7 位新的社区贡献者，新增人数为 smart-doc 社区历史之最。非常感谢下面的几位贡献者踊跃的参加社区奉献。为社区的倒退起到了十分踊跃的作用。
社区奉献
smart-doc 作为同程旅行的大力支持开源我的项目，对于社区奉献的 committer，咱们将提供书籍、文化衫等礼品作为处分，十分激励社区用户参加共建。后续社区也会逐渐减少其余语言的反对。
将来打算
- 新增对 websocket 的反对。
- 新增 GRPC 反对