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

马肤

温馨提示:这篇文章已超过461天没有更新,请注意相关的内容是否还可用!

Smart-doc 3.0.3 版本发布,支持生成 Java WebSocket 接口文档。该版本提供了更加完善的文档生成功能,能够自动化地生成 WebSocket 接口的相关文档,帮助开发人员更加便捷地了解和使用接口。该版本还优化了文档生成的质量和效率,提高了开发人员的工作效率和准确性。这一更新将有助于 Java 开发人员更好地管理和使用 WebSocket 接口,促进软件开发的效率和质量的提升。

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

smart-doc 3.0.3 发布,支持生成 Java WebSocket 接口文档,Smart-doc 3.0.3发布,支持Java WebSocket接口文档生成 第1张
(图片来源网络,侵删)

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

仓库地址

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.

smart-doc 3.0.3 发布,支持生成 Java WebSocket 接口文档,Smart-doc 3.0.3发布,支持Java WebSocket接口文档生成 第2张
(图片来源网络,侵删)

重要更新内容

  • 在导出数据字典时,添加名称字段
  • 添加新的 @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 支持


0
收藏0
文章版权声明:除非注明,否则均为VPS857原创文章,转载或复制请以超链接形式并注明出处。

相关阅读

  • 【研发日记】Matlab/Simulink自动生成代码(二)——五种选择结构实现方法,Matlab/Simulink自动生成代码的五种选择结构实现方法(二),Matlab/Simulink自动生成代码的五种选择结构实现方法详解(二)
  • 超级好用的C++实用库之跨平台实用方法,跨平台实用方法的C++实用库超好用指南,C++跨平台实用库使用指南,超好用实用方法集合,C++跨平台实用库超好用指南,方法与技巧集合
  • 【动态规划】斐波那契数列模型(C++),斐波那契数列模型(C++实现与动态规划解析),斐波那契数列模型解析与C++实现(动态规划)
  • 【C++】,string类底层的模拟实现,C++中string类的模拟底层实现探究
  • uniapp 小程序实现微信授权登录(前端和后端),Uniapp小程序实现微信授权登录全流程(前端后端全攻略),Uniapp小程序微信授权登录全流程攻略,前端后端全指南
  • Vue脚手架的安装(保姆级教程),Vue脚手架保姆级安装教程,Vue脚手架保姆级安装指南,Vue脚手架保姆级安装指南,从零开始教你如何安装Vue脚手架
  • 如何在树莓派 Raspberry Pi中本地部署一个web站点并实现无公网IP远程访问,树莓派上本地部署Web站点及无公网IP远程访问指南,树莓派部署Web站点及无公网IP远程访问指南,本地部署与远程访问实践,树莓派部署Web站点及无公网IP远程访问实践指南,树莓派部署Web站点及无公网IP远程访问实践指南,本地部署与远程访问详解,树莓派部署Web站点及无公网IP远程访问实践详解,本地部署与远程访问指南,树莓派部署Web站点及无公网IP远程访问实践详解,本地部署与远程访问指南。
  • vue2技术栈实现AI问答机器人功能(流式与非流式两种接口方法),Vue2技术栈实现AI问答机器人功能,流式与非流式接口方法探究,Vue2技术栈实现AI问答机器人功能,流式与非流式接口方法详解
  • 发表评论

    快捷回复:表情:
    评论列表 (暂无评论,0人围观)

    还没有评论,来说两句吧...

    目录[+]

    取消
    微信二维码
    微信二维码
    支付宝二维码