在
Spring Boot 项目中
集成 Swagger 后访问文档出现 4
04 错误是一个较为常见的问题，通常与配置、路径变更或依赖版本不兼容有关。以下是一些可能的原因及对应的解决方案：
### 1
. 检查
Swagger 的访问路径
Spring Boot 集成 Swagger 的访问路径在
Swagger 3.0.0 版本之后发生了变化。如果使用的是
Swagger 3.0.0 或更高版本，访问路径应为：
```
http://127
.0.0.1:8
08
0/
swagger-ui/index
.html
```
而旧版本（
3.0.0 之前）的访问路径为：
```
http://127
.0.0.1:8
08
0/
swagger-ui
.html
```
如果访问路径不正确，就会导致 4
04 错误。请确认使用的
Swagger 版本，并确保访问路径与其匹配[^1]。
### 2
. 确保正确配置了
Swagger
在
Spring Boot 项目中，需要确保正确启用了
Swagger 并进行了配置。通常需要添加以下注解：
```
java
@Configuration
@EnableOpenApi
public class
SwaggerConfig {
// 配置内容
}
```
如果使用的是 `
springfox`，由于其已停止更新，可能无法正常工作，特别是在
Spring Boot 3 中。推荐改用 `
springdoc-openapi`，它支持 OpenAPI
3 规范，并与
Spring Boot 3 兼容[^2]。
###
3. 添加正确的依赖
对于
Spring Boot 3 项目，`
springfox` 不再适用，需要使用 `
springdoc-openapi`。在 `pom
.xml` 文件中添加以下依赖：
```xml
<dependency>
<groupId>org
.springdoc</groupId>
<artifactId>
springdoc-openapi-starter-webmvc-ui</artifactId>
<version>1
.6
.14</version>
</dependency>
```
确保依赖版本与
Spring Boot 版本兼容。如果使用的是较新版本的
Spring Boot，可能需要选择更高版本的 `
springdoc-openapi`。
### 4
. 检查
Spring Boot 的 Web 配置
确保没有错误地配置了静态资源或 URL 映射。如果使用了自定义的 `WebMvcConfigurer`，检查是否覆盖了默认的静态资源处理方式。例如，以下代码可能会导致
Swagger 页面无法访问：
```
java
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry
.addResourceHandler("/**")
.addResourceLocations("classpath:/static/");
}
}
```
上述代码可能会阻止对
Swagger 资源的访问。可以修改为以下方式，确保静态资源和
Swagger 资源都能正确加载：
```
java
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry
.addResourceHandler("/**")
.addResourceLocations("classpath:/static/")
.setCachePeriod(
0);
registry
.addResourceHandler("/
swagger-ui/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/
springdoc/openapi-ui/");
}
}
```
### 5
. 检查应用的上下文路径
如果应用的上下文路径不是默认的 `/`，例如在 `application
.properties` 中配置了 `server
.servlet
.context-path=/api`，那么访问
Swagger 的完整路径应该是：
```
http://127
.0.0.1:8
08
0/api/
swagger-ui/index
.html
```
确保在配置了上下文路径后，正确调整了
Swagger 的访问路径。
### 6
. 检查防火墙或安全配置
如果项目中使用了
Spring Security 或其他安全框架，需要确保没有对
Swagger 资源进行拦截。例如，在
Spring Security 的配置中添加以下代码：
```
java
@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
@Override
protected void configure(HttpSecurity http) throws Exception {
http
.authorizeRequests()
.antMatchers("/
swagger-ui/**", "/v
3/api-docs/**")
.permitAll()
.anyRequest()
.authenticated();
}
}
```
上述代码确保了对
Swagger 资源的访问不受到安全限制。
### 7
. 确保应用启动时没有错误
检查应用启动日志，确认没有与
Swagger 相关的错误或异常。例如，如果依赖版本不兼容，可能会导致应用启动失败，从而无法访问
Swagger 文档。
### 8
. 清理并重新构建项目
如果以上步骤均未解决问题，可以尝试清理项目并重新构建。例如，使用 Maven 执行以下命令：
```bash
mvn clean install
```
然后重新启动应用，尝试访问
Swagger 文档。
---
最低0.47元/天 解锁文章
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
600
