smart-doc 3.0.3 发布，支持生成 Java WebSocket 接口文档

smart-doc 是一款同时支持 JAVA REST API 和 Apache Dubbo RPC 接口文档生成的工具，smart-doc 利用接口泛型和 javadoc 注释自动分析生成 api 接口文档，不采用任何注解侵入到业务代码中。只需要在项目中引入 smart-doc 提供的 maven 或者是 gradle 插件，然后按照规范写好 javadoc 注释即可生成 api 文档。同时 smart-doc 也支持生成 openapi 和 postman 这些规范的文档，生成后可以直接导入相关工具做测试。

目前在国内已被小米、科大讯飞、同程旅行、快手、马蜂窝、顺丰等知名公司所使用。

仓库地址

GitHub - TongchengOpenSource/smart-doc: Smart-doc is a java restful api document generation tool. Smart-doc is based on interface source code analysis to generate interface documentation, completely zero-injection.

重要更新内容

• 在导出数据字典时，添加名称字段
• 添加新的 @extension tag 以支持 openapi 扩展
• 添加 WebSocket 支持
• 优化枚举值在文档中的展示
• 优化 JSR 验证信息的提取，支持将 JSR 相关注解的重要信息提取到文档中，并增加展示开关
• 支持 RPC 多级接口继承解析
• 优化 Solon 框架的解析支持 更多更新内容请查看 Release smart-doc-v3.0.3 · TongchengOpenSource/smart-doc · GitHub

新增贡献者

• @leeyazhou
• @Hans-Wu-cn

本次更新新增 2 位新的社区贡献者，非常感谢上面的两位贡献者积极的参与社区贡献。为社区的发展起到了非常积极的作用。

社区贡献

smart-doc 作为同程旅行大力支持的开源项目，对于社区贡献的 committer ，我们将提供书籍、文化衫等礼品作为奖励，非常欢迎社区用户参与共建。后续社区也会逐步增加其他语言的支持。

未来计划

新增 GRPC 支持