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

功能特性

• 支持生成多种格式文档：Markdown、HTML5、Word、Asciidoctor、Postman Collection、OpenAPI 3.0。 开放文档数据，可自由实现接入文档管理系统。
• 支持扫描生成Jmeter性能测试脚本。
• 支持Apache Dubbo RPC接口文档生成。
• debug接口调试html5页面完全支持文件上传，下载(@download tag标记下载方法)测试。

重要更新内容

1. 支持分批上传文档到 torna#697
2. 支持提取 java record 的注释#703
3. 重构优化 word 模版，也是行业内首次在 word上实现了markdown原样的文档，生成的文档更漂亮 #710
4. 支持 @JsonSerialize(using = ToStringSerializer.class)字段类型的处理。 #715
5. 优化常量获取，兼容更多用户可以在路径中使用各种常量。#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支持