Spring Security配置swagger

### Spring Security环境下配置Swagger

为了确保在启用了Spring Security的项目中能够正常使用Swagger API文档，需要进行特定的安全配置来允许未认证用户访问Swagger的相关资源。具体来说，在安全配置类中定义了哪些路径应该公开给所有人访问。

对于Spring Boot应用而言，通常会创建一个继承自`WebSecurityConfigurerAdapter`的类来进行全局的安全设置[^1]。在此基础上，可以通过重写`configure(HttpSecurity http)`方法指定不需要保护的具体URL模式，比如`/v2/api-docs`, `/swagger-resources/**`, `/configuration/ui`, `/configuration/security`, `/swagger-ui.html`, 和 `/webjars/**`这些与Swagger有关联的部分都应该设为可匿名访问：

@Override
protected void configure(HttpSecurity http) throws Exception {
    http.csrf().disable()
        .authorizeRequests()
            .antMatchers("/v2/api-docs", "/swagger-resources/configuration/ui",
                         "/swagger-resources", "/swagger-resources/configuration/security",
                         "/swagger-ui.html", "/webjars/**").permitAll() // 允许所有用户访问Swagger接口
            .anyRequest().authenticated();  // 所有其他请求都需要身份验证
}

另外，在应用程序启动时还需要确保已经正确设置了Swagger的支持。这一般涉及到两个方面的工作：一是引入必要的依赖项；二是编写相应的Java配置文件以激活并定制化Swagger的功能[^3]。例如，下面这段代码展示了如何通过添加`@Configuration`和`@EnableSwagger2`注解来开启Swagger服务，并且可以根据实际需求调整Docket实例的各项参数：

import org.springframework.context.annotation.Bean;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                    .apis(RequestHandlerSelectors.basePackage("com.example")) // 替换成自己的包名
                    .paths(PathSelectors.any())
                    .build();
    }
}

当上述步骤完成后，如果一切正常的话，则可以在浏览器地址栏输入类似`http://localhost:8080/swagger-ui.html`这样的链接查看API文档界面[^4]。此时即使存在Spring Security防护机制也不会阻止对Swagger页面及其关联数据端点的合法读取操作。