springboot3使用swagger3怎么放行
时间: 2025-04-23 20:13:35 浏览: 38
### Spring Boot 3 中配置 Swagger 3 实现接口文档正常访问
为了使 Spring Boot 3 和 Swagger 3 正常工作并放行接口文档的访问,需要按照特定的方式添加依赖项和配置。
#### 添加 Maven 依赖
对于 Spring Boot 3 版本,推荐使用 `springdoc-openapi` 来替代旧版的 `springfox` 库。以下是适用于 Spring Boot 3 的正确依赖声明:
```xml
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.0.4</version>
</dependency>
```
此依赖会自动配置大多数必要的组件来启动 OpenAPI UI 页面[^1]。
#### 编写配置类 (可选)
通常情况下不需要额外编写配置类,因为 `springdoc-openapi` 已经提供了默认配置。如果确实有自定义需求,则可以通过创建一个 Java 配置文件来进行调整:
```java
import org.springframework.context.annotation.Configuration;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
@Configuration
public class SwaggerConfig {
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.info(new Info().title("My API").version("v1"));
}
}
```
这段代码用于设置 API 文档的基础信息,比如标题和版本号[^2]。
#### 安全配置中的路径排除
当应用集成了安全框架如 Spring Security 后,需确保 `/swagger-ui.html` 或者新的默认 URL 路径 `/v3/api-docs/**`, `/swagger-ui/index.html` 不被拦截器保护起来。可以在 WebSecurityConfigurerAdapter 继承的安全配置中加入如下规则:
```java
@Override
protected void configure(HttpSecurity http) throws Exception {
http.authorizeRequests()
.antMatchers("/v3/api-docs/**", "/swagger-ui/**").permitAll()
.anyRequest().authenticated();
}
```
这一步骤非常重要,它允许未认证用户也能浏览 API 文档页面[^3]。
通过以上步骤可以成功地在 Spring Boot 3 上部署并开放访问 Swagger 接口文档的功能。
阅读全文
相关推荐


















