# springdoc

**Repository Path**: mnxlk/springdoc

## Basic Information

- **Project Name**: springdoc
- **Description**: SpringDoc 是一个基于 OpenAPI 3.0 规范的接口文档生成工具，专为 Spring 生态设计，核心目标是 “零侵入” 生成标准化文档。
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: https://gitee.com/mnxlk
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2025-09-17
- **Last Updated**: 2025-10-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Springdoc API 教程

SpringDoc 是一个基于 OpenAPI 3.0 规范的接口文档生成工具，专为 Spring 生态设计，核心目标是 “零侵入” 生成标准化文档。它解决了 SpringFox（Swagger 2）的诸多痛点：

### 1. 总体概览

[SringDoc 官网](https://springdoc.org/)

![总体概览](images/overview.png)

### 2. 核心优势



*   **原生支持 OpenAPI 3.0**：遵循最新的 OpenAPI 规范，支持接口分组、安全认证、响应示例等丰富特性，文档结构更清晰。

*   **与 Spring 生态无缝融合**：完美适配 Spring Boot 2.x/3.x、Spring WebMvc、Spring WebFlux、Spring Security 等，无需额外适配代码。

*   **轻量化设计**：核心依赖体积小，无冗余组件，启动速度快，不影响业务服务性能。

*   **自动扫描与生成**：通过注解或配置即可自动扫描 Controller、DTO 等，无需手动编写文档内容。

*   **多文档工具兼容**：支持 Swagger UI、ReDoc、APIFOX、Postman 等主流工具导入，满足不同团队的使用习惯。

*   **活跃维护**：作为当前 Spring 官方推荐的文档方案之一，更新频率高，问题响应及时。

### 3. 与 SpringFox（Swagger 2）的对比



| 特性                 | SpringDoc（OpenAPI 3.0） | SpringFox（Swagger 2） |
| ------------------ | ---------------------- | -------------------- |
| 规范支持               | OpenAPI 3.0/3.1（最新）    | Swagger 2.0（老旧）      |
| Spring Boot 3.x 适配 | 完全支持                   | 不支持（已停止维护）           |
| 依赖体积               | 轻量化（核心依赖 < 1MB）        | 较臃肿（依赖较多）            |
| 文档 UI              | 支持 Swagger UI、ReDoc 等  | 仅支持 Swagger UI 2.x   |
| 安全认证集成             | 原生支持 OAuth2、JWT 等      | 需额外配置，兼容性差           |

### 3. 运行界面
* Swagger UI
    ![Swagger UI](images/swagger-ui.png)
* JSON
    ![Swagger JSON](images/json.png)

### 4. 关注作者

| ![http://weixin.qq.com/r/mp/SDlNVfLEyK_3rbY292xa](images/mp.png) | ![https://blog.csdn.net/spb229443329](images/csdn.png) |
|:----------------------------------------------------------------:|:------------------------------------------------------:|
| <span style="color: #0088ff">关注微信公众号：码农小卡拉 </span>  |   <span style="color: #0088ff">关注CSDN：码农小卡拉</span>   |