一款零注解侵入的 API 文档生成工具，你用过吗？

prtyaa 2023-12-31 21:37:06  50640 赞同 0 反对 0

分类：资源

介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念，完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。你只需要按照java-doc标准编写注释， smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman、Collection2.0+、OpenAPI 3.0+的文档。

特点
- 零注解、零学习成本、只需要写标准JAVA注释。
- 基于源代码接口定义自动推导，强大的返回结构推导。
- 支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller书写方式)、Feign。
- 支持Callable、Future、CompletableFuture等异步接口返回的推导。
- 支持JavaBean上的JSR303参数校验规范，包括分组验证。
- 对JSON请求参数的接口能够自动生成模拟JSON参数。
- 对一些常用字段定义能够生成有效的模拟值。
- 支持生成JSON返回值示例。
- 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
- 支持生成多种格式文档：Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。Up- 开放文档数据，可自由实现接入文档管理系统。
- 支持导出错误码和定义在代码中的各种字典码到接口文档。
- 支持Maven、Gradle插件式轻松集成。
- 支持Apache Dubbo RPC接口文档生成。
- debug接口调试html5页面完全支持文件上传，下载(@download tag标记下载方法)测试。
Smart-doc 从 2.0.0 后几乎实现了 swagger ui 的功能，并且比 swagger ui 更简洁大方，也更符合国内开发者的诉求。

当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的，也可以将生成的 openapi 3.0 文档导入到其他ui中渲染展示。

效果示例

1.1 接口文档效果图

1.2 html全局效果

如果您发现该资源为电子书等存在侵权的资源或对该资源描述不正确等，可点击“私信”按钮向作者进行反馈；如作者无回复可进行平台仲裁，我们会在第一时间进行处理！

评价 0 条

相关资源

对线面试官：列出 @Transactional 注解下，事务失效的七种场景 2023-12-30 50404 浏览
@Transactional是一种基于注解管理事务的方式，spring通过动态代理的方式为目标方法实现事务管理的增强。半码博客@Transactional是一种基于注解管理事务的方式，spring通过动态代理的方式为目标方法实现事务管理的增强。 @Transactional使用起来方便，但也需要注意引起@Transactional失效的场景，本文总结了七种情况，下面进行逐一分析。
为什么阿里规定需要在事务注解@Transactional中指定rollbackFor？ 2024-01-01 53893 浏览
阿里巴巴Java规范：方法【edit】需要在Transactional注解指定rollbackFor或者在方法中显示的rollback。
.NET无侵入自动化探针原理和主流实现（二） 2023-12-31 51229 浏览
接上一篇.NET无侵入自动化探针原理和主流实现（一）
一个注解搞定 Spring Security 忽略拦截 2023-12-30 50018 浏览
Spring Security 拦截问题一个注解搞定Spring Security 忽略拦截基于注解形式基于配置形式总结
事务注解 @Transactional 失效的3种场景及解决办法 2023-12-31 50751 浏览
Transactional失效场景介绍第一种 Transactional注解标注方法修饰符为非public时，@Transactional注解将会不起作用。例如以下代码。
Spring Boot 第一个示例的 @RestController 注解 2023-12-29 52890 浏览
在示例源代码类中的第一个注解（annotation）是 @RestController。这个注解被称为 stereotype 注解。在使用 Spring 的时候，需要对注解有所了解。Spring 有多个类型的注解，例如在包 org.springframework.context.annotation 和 org.springframework.stereotype 的注解。不仅仅是 @Component，他的派生注解 @Service、@Controller、@RestController 和 @Repository都在这个包中，实际上它就是在告诉使用者这些注解提供 stereotype 的特性（或者称为功能、作用）。
注解+反射优雅的实现Excel导入导出（通用版） 2023-12-31 48579 浏览
日常在做后台系统的时候会很频繁的遇到Excel导入导出的问题，正好这次在做一个后台系统，就想着写一个公用工具来进行Excel的导入导出。一般我们在导出的时候都是导出的前端表格，而前端表格同时也会对应的在后台有一个映射类。
.NET无侵入自动化探针原理和主流实现（一） 2023-12-31 49409 浏览
许多人对基于 OpenTelemetry .NET 的观测指标和无侵入自动化探针颇感兴趣。事实上，我已计划抽出时间，与大家分享这方面的内容。然而，因为 .NET 无侵入自动化探针的实现原理相当复杂，理解和完全掌握原理有很大差别。为确保文章质量和严谨性，撰写过程耗时较长，因此现在才能与大家见面。
Spring Boot 第一个示例 @EnableAutoConfiguration 注解 2023-12-29 51859 浏览
在示例代码中的第二个注解是 @EnableAutoConfiguration。
Spring Boot 这么火，常用注解和原理都给你整理好了！ 2023-12-28 48582 浏览
Spring Boot 这么火，常用注解和原理都给你整理好了！

一款零注解侵入的 API 文档生成工具，你用过吗？

特点

效果示例

1.1 接口文档效果图

1.2 html全局效果

相关资源

关注我们