smart-doc 3.0.7 发布,支持生成 gRPC 协议接口文档


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

重要更新内容

  • 更新 SolonRequestMappingHandler.java。由 @aqnghu 在 https://github.com/TongchengOpenSource/smart-doc/pull/849 提交
  • 功能:添加 Grpc 支持。由 @linwumingshi 在 https://github.com/TongchengOpenSource/smart-doc/pull/851 提交
  • 功能:添加 WebSocket 的 HTML 和 ASCII 文档支持。由 @linwumingshi 在 https://github.com/TongchengOpenSource/smart-doc/pull/855 提交
  • 修复:解决使用 Dubbo RPC或 @javadoc标签覆盖父类或接口但没有 Javadoc 注释时生成的接口文档缺乏描述信息的问题。由 @linwumingshi 在 https://github.com/TongchengOpenSource/smart-doc/pull/866 提交
  • 功能:添加对带有枚举类型键的 Map 的支持。由 @linwumingshi 在 https://github.com/TongchengOpenSource/smart-doc/pull/870 提交
  • 功能:添加对 @JsonView的支持。由 @linwumingshi 在 https://github.com/TongchengOpenSource/smart-doc/pull/875 提交
  • 依赖项更新:将 org.eclipse.jgit:org.eclipse.jgit 从 5.13.2.202306221912-r 升级到 5.13.3.202401111512-r。由 @dependabot 在 https://github.com/TongchengOpenSource/smart-doc/pull/782 提交
  •  依赖项更新:将 org.slf4j:slf4j-api 从 2.0.13 升级到 2.0.16。由 @dependabot 在 https://github.com/TongchengOpenSource/smart-doc/pull/885 提
  • 依赖项更新:将 com.ibeetl:beetl 从 3.16.2.RELEASE 升级到 3.17.0.RELEASE。由 @dependabot 在 https://github.com/TongchengOpenSource/smart-doc/pull/886 提交
  •  依赖项更新:将 org.apache.maven.plugins:maven-gpg-plugin 从 3.2.4 升级到 3.2.5。由 @dependabot 在 https://github.com/TongchengOpenSource/smart-doc/pull/887 提交
  • 依赖项更新:将 org.junit.jupiter:junit-jupiter 从 5.10.2 升级到 5.11.0。由 @dependabot 在 https://github.com/TongchengOpenSource/smart-doc/pull/888 提交
  • 功能:添加对WebSocket消息和响应参数的支持。由 @linwumingshi 在 https://github.com/TongchengOpenSource/smart-doc/pull/882 提交
  • 修复(RPC):修复构造 RPC 时发生的 ClassCastException 错误。由 @xiangganLuo 在 https://github.com/TongchengOpenSource/smart-doc/pull/890 提交
  • 增强: 增强 IJavadocDocTemplate,为方法文档添加泛型支持。由 @linwumingshi 在 https://github.com/TongchengOpenSource/smart-doc/pull/891 提交

本次主要新增了gRPC协议接口文档的支持,对于在Java项目中实现的gRPC可以轻松生成接口文档,优化和完善了WebSocket文档,支持在文档中展示WebSocket的Message参数和相应参数。

当然无论是gRPC还是WebSocket都都属于近期版本才做的支持, 对它们的标准化支持社区也是在摸着石头过河,我们也需要用户不断的反馈和迭代完善,因此欢迎社区用户多给我们提优化意见和测试用例。

新增贡献者

  • @Itswag

非常感谢上面的贡献者积极的参与社区贡献。

致谢

感谢 @linwumingshi 同学在本次的版本迭代种提供了对gRPC协议的支持


相關推薦

2024-06-12

smart-doc 是一款同时支持 JAVA REST API 和 Apache Dubbo RPC 接口文档生成的工具,smart-doc 利用接口泛型和 javadoc 注释自动分析生成 api 接口文档,不采用任何注解侵入到业务代码中。只需要在项目中引入 smart-doc 提供的 maven 或者是 gradle

2024-07-16

smart-doc 是一款同时支持 JAVA REST API 和 Apache Dubbo RPC 接口文档生成的工具,smart-doc 利用接口泛型和 javadoc 注释自动分析生成 api 接口文档,不采用任何注解侵入到业务代码中。只需要在项目中引入 smart-doc 提供的 maven 或者是 gradle

2023-12-21

尊敬的Smart-Doc社区用户:         我们很高兴地宣布,Smart-Doc 3.0.1版本现已正式发布!在这个新版本中,我们对现有的功能进行了优化和改进,并新增了三个重要的功能。在本次的版本迭代中,我们

2023-07-11

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,

2022-11-03

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,

2022-12-14

个需求和痛点,或许可以尝试一下使用 Torna 推荐组合 smart-doc + Torna 实现文档全流程自动化 如果您使用 Java 语言,推荐使用 smart-doc + Torna smart-doc + Torna 组成行业领先的文档生成和管理解决方案,使用 smart-doc 无侵入完

2023-11-23

痛点,或许可以尝试一下使用 Torna 快速开始 推荐组合 smart-doc + Torna 实现文档全流程自动化 如果您使用 Java 语言,推荐使用 smart-doc + Torna smart-doc + Torna 组成行业领先的文档生成和管理解决方案,使用 smart-doc 无侵入完成 Java

2023-11-01

api-testing atest 版本发布 v0.0.14 atest 是一款用 Golang 编写的、开源的接口测试工具。 你可以在容器中启动: docker run --network host \ linuxsuren/api-testing:master 或者,直接下载二进制文件后启动: atest server --local-

2023-03-04

看看是否有你期待的功能! 1、协议转换功能上线 之前发布的 Apinto v0.10.0 已经支持了多协议的基本功能,实现多协议支持的一次验证。本次最新版本可以支持 HTTP 与 gRPC、HTTP 与 Dubbo2 之间的协议转换。 在不久前,我们通过社

2024-06-15

atest 发布 v0.0.17 atest 是致力于帮助开发者持续保持高质量 API 的开源接口工具。 你可以在命令行终端或者容器中启动: docker run -p 8080:8080 ghcr.io/linuxsuren/api-testing:v0.0.17 亮点 我们提供了基于 Electron 的桌面应用

2022-09-30

动态配置常用参数。 通知公告 系统通知公告信息发布维护。 操作日志 系统正常操作日志记录和查询;系统异常信息日志记录和查询。 登录日志 系统登录日志记录查询包含登录异常。 文件管理 系统文

2022-11-19

和微服务技术下遇到的新问题。 在 9 月底,Apache APISIX 发布了 3.0.0-beta 预览版,为用户们提前带来了一些新的功能体验。今天,APISIX 正式发布了 3.0.0 版本,将产品从体验和功能角度,带到了新一轮的进程中。 经过迭代的 3.0.0

2023-01-19

,完善注册发现、配置管理对常用服务的对接,为下一步发布微服务组件做准备。 新特性 将耦合较重的redis组件从主框架中解耦,作为社区组件提供。原有主框架增加redis接口定义,社区组件redis提供具体的接口实现。因此

2024-04-29

何环境中运行的现代开源高性能 RPC 框架。gRPC 1.63.0 现已发布,包含了一些完善、改进和错误修复;具体更新内容如下: Core [Deps] 向后移植:Protobuf 升级到 v26.1。 ( #36353 ) [CMake] 添加 gRPC_USE_SYSTEMD 选项。 ( #34384&nb