SpringBoot配置Swagger开启页面访问限制

在Spring Boot项目中使用Swagger时,可以通过配置文件来限制对Swagger UI的访问。以下是一个使用Spring Security来限制对Swagger UI的访问的示例:

  1. 首先,在pom.xml中添加Spring Security依赖:



<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>
  1. 接下来,在application.propertiesapplication.yml中配置Swagger的基本路径访问权限:



# application.properties
springfox.documentation.swagger-ui.enabled=true
  1. 然后,配置Spring Security来保护Swagger UI路径。在WebSecurityConfigurerAdapter的实现中添加对Swagger UI的保护:



import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
 
@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {
 
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            // 允许对Swagger UI的访问
            .authorizeRequests()
            .antMatchers("/swagger-ui.html").permitAll()
            .antMatchers("/v2/api-docs").permitAll()
            .antMatchers("/swagger-resources/**").permitAll()
            .antMatchers("/webjars/**").permitAll()
            // 其他所有请求都需要验证
            .anyRequest().authenticated()
            .and()
            // 禁用CSRF保护,因为Swagger不支持CSRF
            .csrf().disable();
    }
}

在上述配置中,我们通过.antMatchers()方法指定了对Swagger UI资源的访问权限,使用.permitAll()来允许它们被匿名访问。同时,关闭了CSRF保护,因为Swagger UI不支持CSRF令牌。

确保你的应用已经配置了用户源和用户详情服务,这样才能保护其他路径不受未授权访问。

以上代码仅供参考,具体实现可能需要根据实际项目需求进行调整。

最后修改于:2024年09月04日 21:57

评论已关闭

推荐阅读

DDPG 模型解析,附Pytorch完整代码
2024年11月24日
DQN 模型解析,附Pytorch完整代码
2024年11月24日
AIGC实战——Transformer模型
2024年12月01日
Socket TCP 和 UDP 编程基础(Python)
2024年11月30日
python , tcp , udp
如何使用 ChatGPT 进行学术润色?你需要这些指令
2024年12月01日
AI
最新 Python 调用 OpenAi 详细教程实现问答、图像合成、图像理解、语音合成、语音识别(详细教程)
2024年11月24日
ChatGPT 和 DALL·E 2 配合生成故事绘本
2024年12月01日
omegaconf,一个超强的 Python 库!
2024年11月24日
【视觉AIGC识别】误差特征、人脸伪造检测、其他类型假图检测
2024年12月01日
[超级详细]如何在深度学习训练模型过程中使用 GPU 加速
2024年11月29日
Python 物理引擎pymunk最完整教程
2024年11月27日
MediaPipe 人体姿态与手指关键点检测教程
2024年11月27日
深入了解 Taipy:Python 打造 Web 应用的全面教程
2024年11月26日
基于Transformer的时间序列预测模型
2024年11月25日
Python在金融大数据分析中的AI应用(股价分析、量化交易)实战
2024年11月25日
AIGC Gradio系列学习教程之Components
2024年12月01日
Python3 `asyncio` — 异步 I/O,事件循环和并发工具
2024年11月30日
llama-factory SFT系列教程:大模型在自定义数据集 LoRA 训练与部署
2024年12月01日
Python 多线程和多进程用法
2024年11月24日
Python socket详解,全网最全教程
2024年11月27日