关于 SpringDoc

SpringDoc 是一款基于 JavaDoc 的 API 文档生成工具，专为 Spring Boot 应用设计。

特性

• 零侵入设计：基于 javadoc 注释自动生成文档，无需添加额外注解
• 完全兼容：自动生成符合规范的 openapi 结构体
• 美观易用：内部整合了 Knife4j 作为接口文档的可视化界面

版本支持

目前 SpringDoc 仅支持 SpringBoot 2.x 系列版本。我们计划在未来版本中支持 SpringBoot 3.x。

优势

与传统的 Swagger 或 SpringDoc-OpenAPI 相比，本项目具有以下优势：

1. 开发体验更好：无需编写大量注解，利用 IDE 自带的 JavaDoc 支持即可完成文档编写
2. 代码更整洁：避免了代码中充斥大量与业务无关的文档注解
3. 维护更方便：文档与代码注释合一，避免了文档与代码不同步的问题
4. 界面更美观：整合 Knife4j 提供现代化的文档界面

工作原理

SpringDoc 利用 JavaDoc 注解处理器在编译时提取注释信息，然后在运行时生成 OpenAPI 规范文档，实现了文档与代码的无缝集成。

下一步

查看快速开始章节，了解如何在项目中集成 SpringDoc。