smart-doc 3.0.6 发布,基于 SPI 机制支持企业自定义扩展解析内部框架


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

重要更新内容

  • 新增 对Jackson框架JsonFormat的支持
  • 修复使用`@order` 指定接口自定义序号排序错误 bug
  • 基于 SPI 机制开放 smart-doc 的解析扩展能力,支持企业扩展解析内部自定义 Java Web 框架
  • 社区基于 vitePress 重构了官方文档

本次版本迭代后企业可以在不修改smart-doc官方源代码以及插件的情况下扩展smart-doc完成对一些内部自定义web框架的解析, 并且仍然可以保证上线产物中没有稳定生成框架相关的代码

新增贡献者

  • @Itswag

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

致谢

感谢@linwumingshi 同学在本次的版本迭代中作出了非常多的重要共贡献

未来计划

  • 新增 GRPC 支持 (欢迎社区开发参与贡献)

相關推薦

2022-11-08

池实践,美团内部已经有该理论成熟的应用经验 v1.0.9 发布记录 Features 告警类型新增邮件告警渠道,感谢 @林林林 提供实现 adapter 模块新增 grpc 服务端线程池管理 BugFix AbstractDtpNotifier 添加无参构造函数,修复自

2023-02-09

实践,美团内部已经有该理论成熟的应用经验 v1.1.0 发布记录 Features adapter 模块新增 motan rpc 框架线程池管理 adapter 模块新增 okhttp3 线程池管理 新增 OrderedDtpExecutor,感谢 @hailang 提供实现 adapter 模块新增 brpc(sta

2023-07-11

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

2023-03-30

实践,美团内部已经有该理论成熟的应用经验 v1.1.2 发布记录 Feature 增加对 juc 线程池的动态调参能力,感谢@wenpan 的贡献 增加 ScheduledDtpExecutor,感谢@WindSearcher 的贡献 增加 spring-cloud-tencent 配置中心 polaris 的支持

2022-11-03

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

2023-07-09

YMP 是一个非常简单、易用的轻量级 Java 应用开发框架,涵盖 AOP、IoC、WebMVC、ORM、Validation、Plugin、Serv、Cache 等特性,主要技术特点: 采用组件化、模块方式打包,可按需装配,灵活可扩展; 采用微内核实现 AutoScan、AOP、

2023-09-28

dynamic-tp v1.1.4 已经发布,轻量级动态线程池 此版本更新内容包括: Feature 支持 Spring 项目,SpringBoot 相关特性只在 starter 模块引入,@炼龙 添加 jvmti 黑科技模块,方便集成管理各种三方包线程池,@炼龙 升级 VariableLinke

2024-06-12

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

2023-04-27

11月24日,Spring Boot 3.0 以及 Spring Cloud 2022.0.0 等全新版本发布,整个Java 社区也步入的 Java 17 和 Spring Boot 3 的新时代。紧跟 Java 技术和 Spring 社区的发展,让更多质量更好、性能更优的新特性服务于实际的开发工作,Dante Cloud 也同

2022-11-13

Dante Cloud 是一款企业级微服务架构和服务能力开发平台。首个全面拥抱 Spring Authorization Server 的版本,基于Spring Boot 2.7.5、Spring Cloud 2021.0.5、Spring Cloud Alibaba 2021.0.4.0、 Spring Authorization Server 0.3.1、Nacos 2.1.2 等最新版本开发的多租户

2022-04-07

一、背景 Apache Flink 作为新一代的实时计算框架已经被应用到各个行业与领域,虽说应用程度不同,但都会遇到一些使用上的痛点,基础的应用痛点比如 FlinkSQL 作业提交不友好、作业无监控报警等。很大程度上说,FlinkSQL 大大

2023-11-06

OpenHarmony 4.0 版本现已发布,开发套件同步升级到API 10。相比3.2 Release版本,新增4000多个ArkTS API,应用开发能力更加丰富;HDF新增200多个HDI接口,硬件适配更加便捷;持续优化图形框架和方舟编译器(ArkCompiler),用户交互体验得

2023-06-22

1、smart-flow 简介 smart-flow 是一个轻量、灵活的业务流程编排框架,支持业务流程中常见的条件分支控制、子流程、业务组件异步和降级等功能。同时 smart-flow 也是一款具备可观测性的流程编排框架,流程结构拓扑、执行路径跟

2023-01-06

能,支持节点的迁移。另外,我们也修复了一些问题,并发布到 1.7.x 版本中。 12月的版本发布包括: v1.8.0-alpha.3:包含 1.8.0 已开发完成的新功能 v1.7.4:包含 bug fixes v1.7.5:包含 bug fixes 连接格式优化和自定义:序