讲师中心 微信公众号
AI工具推荐 视频效率加速

Spring Boot 集成 Swagger UI 404 问题的完整解决方案

千丽酱_5382

千丽酱_5382

发布时间:2026-07-04 17:54:21

|

559人浏览过

|

来源于php中文网

原创

Spring Boot 集成 Swagger UI 404 问题的完整解决方案

Spring Boot 2.7.x 中使用 Springfox 2.9.2 时,Swagger UI 访问路径(如 /swagger-ui.html)返回 404,根本原因是静态资源未正确注册;需显式配置 ResourceHandler 并继承 WebMvcConfigurerAdapter(Spring Boot 2.x 兼容方案)。

spring boot 2.7.x 中使用 springfox 2.9.2 时,swagger ui 访问路径(如 `/swagger-ui.html`)返回 404,根本原因是静态资源未正确注册;需显式配置 `resourcehandler` 并继承 `webmvcconfigureradapter`(spring boot 2.x 兼容方案)。

在 Spring Boot 2.7.10 环境下,即使引入了 springfox-swagger-ui 依赖,Swagger UI 的前端资源(HTML、JS、CSS)仍不会自动暴露——因为 Spring Boot 2.x 默认禁用了传统 WebMvc 静态资源映射逻辑,而 Springfox 2.x(尤其是 2.9.2)尚未完全适配 Spring Boot 2.x 的 WebMvcConfigurer 新机制。因此,仅添加 @EnableSwagger2 和 Docket Bean 是不够的,必须手动注册 Swagger UI 所需的静态资源路径。

✅ 正确配置步骤

1. 保留兼容性依赖(适用于 Spring Boot 2.7.x)

你的 build.gradle 中依赖组合基本正确,但需注意:

  • springfox-swagger2:2.9.2 与 springfox-swagger-ui:2.9.2 必须版本严格一致;
  • 不要混用 springdoc-openapi(那是 Spring Boot 3+ 的现代替代方案);
  • @EnableWebMvc 会关闭 Spring Boot 的默认 MVC 配置,因此必须自行补全所有资源处理逻辑(包括 Swagger UI + WebJars)。

2. 修正 SwaggerConfig.java

关键修改点如下:

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载
package com.company.app.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; // ? 推荐使用接口(Spring 5.0+)
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
// ⚠️ 注意:Spring Boot 2.7 已弃用 WebMvcConfigurerAdapter(已标记为 @Deprecated)
// 改用实现 WebMvcConfigurer 接口(更符合当前最佳实践)
public class SwaggerConfig implements WebMvcConfigurer {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.company")) // 扫描你的 Controller 包
                .paths(PathSelectors.any()) // ? 建议设为 any() 或合理路径规则,避免遗漏
                .build();
    }

    // ✅ 必须重写:注册 Swagger UI 静态资源
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 映射 swagger-ui.html 到 classpath:/META-INF/resources/
        registry.addResourceHandler("/swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        // 映射 webjars(Swagger UI 依赖的 JS/CSS 库)
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

? 为什么是 /swagger-ui.html?
Springfox 2.9.2 默认入口页为 swagger-ui.html(而非 /swagger-ui/),访问地址应为:
http://localhost:8080/swagger-ui.html
✅ 确保 URL 后缀 .html 存在且无多余斜杠。

3. 验证控制器是否被扫描

确保你的 REST 控roller 类位于 com.company 或其子包下,并使用了 @RestController 或 @RequestMapping 注解。例如:

@RestController
@RequestMapping("/api/v1")
public class UserController {
    @GetMapping("/users")
    public List<String> listUsers() {
        return Arrays.asList("Alice", "Bob");
    }
}

⚠️ 注意事项与常见陷阱

  • ❌ 不要同时启用 @EnableWebMvc 和 WebMvcConfigurer 实现——@EnableWebMvc 会覆盖 Spring Boot 自动配置,此时你必须自行注册所有资源处理器(包括 favicon、静态资源等),否则可能影响其他静态文件访问;
  • ✅ 若无需完全接管 MVC 配置,建议移除 @EnableWebMvc(它不是 Swagger 所必需),仅保留 @Configuration + WebMvcConfigurer 实现即可;
  • ? 路径匹配建议:PathSelectors.any() 比 ant("/api/**") 更稳妥,避免因路径前缀不一致导致 API 未被纳入文档;
  • ? 清理缓存:修改配置后,重启应用并硬刷新浏览器(Ctrl+F5),避免旧版 Swagger 缓存干扰;
  • ? 检查 JAR 包内容:确认 springfox-swagger-ui-2.9.2.jar 内含 META-INF/resources/swagger-ui.html 及 webjars/ 资源(可通过解压验证)。

✅ 最终访问方式

启动应用后,打开浏览器访问:
? http://localhost:8080/swagger-ui.html

若一切配置正确,将看到 Swagger UI 界面,并自动加载 /v2/api-docs 提供的 OpenAPI 规范。

? 升级建议(长期维护视角):
Springfox 2.x 已停止维护(last release: 2020),官方推荐迁移到 springdoc-openapi(支持 Spring Boot 2.6+ / 3.x,零配置、响应式友好、Active Swagger UI 4.x)。迁移只需替换依赖 + 删除配置类,大幅降低维护成本。

热门AI工具

更多
超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

相关专题

更多
spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

591

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

1435

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

4466

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

436

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

620

2025.12.24

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

385

2026.02.11

Kotlin协程编程与Spring Boot集成实践
Kotlin协程编程与Spring Boot集成实践

本专题围绕 Kotlin 协程机制展开,深入讲解挂起函数、协程作用域、结构化并发与异常处理机制,并结合 Spring Boot 展示协程在后端开发中的实际应用。内容涵盖异步接口设计、数据库调用优化、线程资源管理以及性能调优策略,帮助开发者构建更加简洁高效的 Kotlin 后端服务架构。

351

2026.02.12

Spring Boot 项目开发与实战
Spring Boot 项目开发与实战

以 Spring Boot 为核心,讲解项目的快速初始化(Spring Initializr)、自动配置与 Starter 依赖原理、配置文件(application.yml)多环境管理、RESTful API 接口开发与参数校验、MyBatis / MyBatis-Plus / Spring Data JPA 数据持久层整合、Redis 缓存集成、统一异常处理与全局响应封装、Swagger / Knife4j 接口文档生成,以及 Ma

306

2026.04.17

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Spring Boot 官方快速入门指南
Spring Boot 官方快速入门指南

共0课时 | 0人学习

Spring Boot 官方参考文档
Spring Boot 官方参考文档

共0课时 | 0人学习

尚硅谷新版SpringBoot3教程
尚硅谷新版SpringBoot3教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn