Spring Boot API文档方案升级：从Springfox到SpringDoc OpenAPI的完整迁移指南

最新推荐文章于 2025-08-09 11:57:12 发布

码农阿豪@新空间

最新推荐文章于 2025-08-09 11:57:12 发布

阅读量1.3k

点赞数 37

CC 4.0 BY-SA版权

分类专栏：包罗万象文章标签： spring boot 后端 java

本文链接：https://blog.csdn.net/weixin_44976692/article/details/150072437

包罗万象专栏收录该内容

713 篇文章

订阅专栏

个人名片

🎓作者简介：java领域优质创作者
🌐个人主页：码农阿豪
📞工作室：新空间代码工作室（提供各种软件服务)
💌个人邮箱：[2435024119@qq.com]
📱个人微信：15279484656
🌐个人导航网站：www.forff.top
💡座右铭：总有人要赢。为什么不能是我呢？

专栏导航：

码农阿豪系列专栏导航
面试专栏：收集了java相关高频面试题，面试实战总结🍻🎉🖥️
Spring5系列专栏：整理了Spring5重要知识点与实战演练，有案例可直接使用🚀🔧💻
Redis专栏：Redis从零到一学习分享，经验总结，案例实战💐📝💡
全栈系列专栏：海纳百川有容乃大，可能你想要的东西里面都有🤸🌱🚀

Spring Boot API文档方案升级：从Springfox到SpringDoc OpenAPI的完整迁移指南

引言

在Spring Boot项目中，API文档是前后端协作的重要桥梁。长期以来，Springfox（Swagger）一直是Java生态中最流行的API文档工具之一。但随着Spring Boot版本的迭代，特别是2.6+版本后，Springfox的兼容性问题逐渐显现，导致许多开发者转向更现代的替代方案——SpringDoc OpenAPI。

本文将详细介绍：

Springfox的常见问题（如NullPointerException）
为何选择SpringDoc OpenAPI
完整迁移步骤（含代码示例）
最佳实践与优化建议

1. Springfox的常见问题

1.1 典型错误分析

在Spring Boot 2.6+中，启动时可能遇到以下错误：

Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
...
Caused by: java.lang.NullPointerException: null
    at springfox.documentation.spi.service.contexts.Orderings$8.compare(Orderings.java:112)

原因：
Spring Boot 2.6+默认使用PathPattern进行路径匹配，而Springfox 2.x仅支持传统的AntPathMatcher，导致空指针异常。

1.2 临时解决方案

在application.properties中强制使用AntPathMatcher：

spring.mvc.pathmatch.matching-strategy=ant_path_matcher

但这只是权宜之计，长期推荐迁移到SpringDoc。

2. 为何选择SpringDoc OpenAPI？

特性	Springfox	SpringDoc
兼容性	仅支持Spring Boot <2.6	完美支持Spring Boot 2.6+
注解标准	Swagger 2.0	OpenAPI 3.0
自动发现机制	有限	强大
JWT支持	需手动配置	内置支持
社区活跃度	维护停滞	持续更新

3. 完整迁移步骤

3.1 移除Springfox依赖

在pom.xml中删除所有Springfox相关依赖：

<!-- 移除以下依赖 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

3.2 添加SpringDoc依赖

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.6.14</version>
</dependency>

3.3 替换配置类

将原有的SwaggerConfig替换为OpenApiConfig：

@Configuration
public class OpenApiConfig {
    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("手机号碰撞系统API")
                        .version("v1.0.0")
                        .contact(new Contact()
                                .name("开发团队")
                                .url("https://github.com/your-repo")
                                .email("dev@example.com")))
                .addSecurityItem(new SecurityRequirement().addList("BearerAuth"))
                .components(new Components()
                        .addSecuritySchemes("BearerAuth", 
                            new SecurityScheme()
                                .type(SecurityScheme.Type.HTTP)
                                .scheme("bearer")
                                .bearerFormat("JWT")));
    }
}

3.4 修改启动类

移除@EnableSwagger2注解：

@SpringBootApplication
public class AppApplication {
    public static void main(String[] args) {
        SpringApplication.run(AppApplication.class, args);
    }
}

3.5 更新Controller注解

替换Swagger注解为OpenAPI 3.0标准：

@RestController
@Tag(name = "手机号管理", description = "手机号碰撞相关API")
@RequestMapping("/api/phones")
public class PhoneController {

    @Operation(summary = "获取手机号信息", description = "根据ID查询手机号")
    @GetMapping("/{id}")
    public ResponseEntity<Phone> getPhone(
            @Parameter(description = "手机号ID", required = true)
            @PathVariable Long id) {
        // 业务逻辑
    }
}

4. 高级配置与优化

4.1 分组API文档

@Bean
@GroupedOpenApi
public GroupedOpenApi userApi() {
    return GroupedOpenApi.builder()
            .group("用户管理API")
            .pathsToMatch("/api/user/")
            .build();
}

4.2 自定义Swagger UI

在application.properties中配置：

springdoc.swagger-ui.path=/swagger-ui.html
springdoc.swagger-ui.operationsSorter=alpha
springdoc.swagger-ui.tagsSorter=alpha
springdoc.swagger-ui.doc-expansion=none

4.3 隐藏特定接口

使用@Hidden注解：

@Hidden
@GetMapping("/internal")
public String internalApi() {
    return "内部接口";
}

5. 迁移后的效果验证

访问Swagger UI：
http://localhost:8080/swagger-ui.html
查看OpenAPI JSON：
http://localhost:8080/v3/api-docs
验证JWT支持：
在Swagger UI中点击"Authorize"按钮，输入Bearer Token测试。