您现在的位置是:首页 > 文章详情

smart-doc 3.0.8 发布,Java 零注解 API 文档生成工具

日期:2024-09-18点击:117

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

重要更新内容

当然,这里是翻译后的提交日志:

  • 正确处理单个 @ServerEndpoint 属性值,由 @linwumingshi 在 #902 中提交。
  • 重构(torna-builder): 简化 Torna API 文档生成,由 @linwumingshi 在 #903 中提交。
  • 新功能 ✨ 将瞬态字段序列化拆分为请求和响应标志,由 @linwumingshi 在 #904 中提交。
  • 修复在 Linux 上生成 REST JMeter.jmx 时出现的 NATIVE_NOT_ALLOWED 问题,由 @linwumingshi 在 #908 中提交。
  • 新功能: 修复无法在枚举上使用 JsonValue 注解的问题,由 @shalousun 在 #910 中提交。
  • 新功能(params): 添加对嵌套映射参数处理的支持,由 @linwumingshi 在 #914 中提交。
  • 新功能(enum): 支持在枚举字段上使用 @JsonValue 注解,由 @linwumingshi 在 #916 中提交。
  • 修复由于枚举键映射中的重复 ApiParam ID 导致的堆栈溢出问题,由 @linwumingshi 在 #917 中提交。
  • 新功能: 支持 Postman 集合分组,由 @shalousun 在 #920 中提交。

本次主要修复了在枚举上使用@JsonValue注解无法正确解析出预期结果问题;完善了使用enum作为Map key的支持;配置了分组后导出到Postman中也支持分组。

社区共建

欢迎对smart-doc项目感兴趣的同学们加入我们的社区共建活动。目前,我们针对Java的支持已经相当完善,未来计划扩展对Go和Rust等编程语言的支持。

同时,我们也在积极推进smart-doc的国际化发展,致力于打造一个面向全球开发者的开放、包容的社区。

原文链接:https://www.oschina.net/news/312378/smart-doc-3-0-8
关注公众号

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。

持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。

文章评论

共有0条评论来说两句吧...

文章二维码

扫描即可查看该文章

点击排行

推荐阅读

最新文章