내 프로젝트에는 Spring Security가 있습니다. 주요 문제 : http : // localhost : 8080 / api / v2 / api-docs 에서 swagger URL에 액세스 할 수 없습니다 . 인증 헤더가 없거나 잘못되었습니다.
브라우저 창의 스크린 샷
My pom.xml에는 다음 항목이 있습니다.
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.4.0</version>
</dependency>
SwaggerConfig :
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2).select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
ApiInfo apiInfo = new ApiInfo("My REST API", "Some custom description of API.", "API TOS", "Terms of service", "myeaddress@company.com", "License of API", "API license URL");
return apiInfo;
}
AppConfig :
@Configuration
@EnableWebMvc
@ComponentScan(basePackages = { "com.musigma.esp2" })
@Import(SwaggerConfig.class)
public class AppConfig extends WebMvcConfigurerAdapter {
// ========= Overrides ===========
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LocaleChangeInterceptor());
}
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
web.xml 항목 :
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>
com.musigma.esp2.configuration.AppConfig
com.musigma.esp2.configuration.WebSecurityConfiguration
com.musigma.esp2.configuration.PersistenceConfig
com.musigma.esp2.configuration.ACLConfig
com.musigma.esp2.configuration.SwaggerConfig
</param-value>
</context-param>
WebSecurityConfig :
@Configuration
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
@ComponentScan(basePackages = { "com.musigma.esp2.service", "com.musigma.esp2.security" })
public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter {
@Override
protected void configure(HttpSecurity httpSecurity) throws Exception {
httpSecurity
.csrf()
.disable()
.exceptionHandling()
.authenticationEntryPoint(this.unauthorizedHandler)
.and()
.sessionManagement()
.sessionCreationPolicy(SessionCreationPolicy.STATELESS)
.and()
.authorizeRequests()
.antMatchers("/auth/login", "/auth/logout").permitAll()
.antMatchers("/api/**").authenticated()
.anyRequest().authenticated();
// custom JSON based authentication by POST of {"username":"<name>","password":"<password>"} which sets the token header upon authentication
httpSecurity.addFilterBefore(loginFilter(), UsernamePasswordAuthenticationFilter.class);
// custom Token based authentication based on the header previously given to the client
httpSecurity.addFilterBefore(new StatelessTokenAuthenticationFilter(tokenAuthenticationService), UsernamePasswordAuthenticationFilter.class);
}
}
답변
이것을 WebSecurityConfiguration 클래스에 추가하면 트릭을 수행 할 수 있습니다.
@Configuration
public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter {
@Override
public void configure(WebSecurity web) throws Exception {
web.ignoring().antMatchers("/v2/api-docs",
"/configuration/ui",
"/swagger-resources/**",
"/configuration/security",
"/swagger-ui.html",
"/webjars/**");
}
}
답변
나는 / configuration / ** 및 / swagger-resources / **로 업데이트했으며 저에게 효과적이었습니다.
@Override
public void configure(WebSecurity web) throws Exception {
web.ignoring().antMatchers("/v2/api-docs", "/configuration/ui", "/swagger-resources/**", "/configuration/**", "/swagger-ui.html", "/webjars/**");
}
답변
Spring Boot 2.0.0.M7 + Spring Security + Springfox 2.8.0을 사용하여 동일한 문제가 발생했습니다. 그리고 Swagger UI 리소스에 대한 공개 액세스를 허용하는 다음 보안 구성을 사용하여 문제를 해결했습니다.
@Configuration
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true, securedEnabled = true)
public class SecurityConfiguration extends WebSecurityConfigurerAdapter {
private static final String[] AUTH_WHITELIST = {
// -- swagger ui
"/v2/api-docs",
"/swagger-resources",
"/swagger-resources/**",
"/configuration/ui",
"/configuration/security",
"/swagger-ui.html",
"/webjars/**"
// other public endpoints of your API may be appended to this array
};
@Override
protected void configure(HttpSecurity http) throws Exception {
http.
// ... here goes your custom security configuration
authorizeRequests().
antMatchers(AUTH_WHITELIST).permitAll(). // whitelist Swagger UI resources
// ... here goes your custom security configuration
antMatchers("/**").authenticated(); // require authentication for any endpoint that's not whitelisted
}
}
답변
최신 swagger 3 버전을 사용하는 사람들을 위해 org.springdoc:springdoc-openapi-ui
@Configuration
public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter {
@Override
public void configure(WebSecurity web) throws Exception {
web.ignoring().antMatchers("/v3/api-docs/**", "/swagger-ui.html", "/swagger-ui/**");
}
}
답변
Springfox 버전이 2.5보다 높은 경우 아래와 같이 WebSecurityConfiguration을 추가해야합니다.
@Override
public void configure(HttpSecurity http) throws Exception {
// TODO Auto-generated method stub
http.authorizeRequests()
.antMatchers("/v2/api-docs", "/swagger-resources/configuration/ui", "/swagger-resources", "/swagger-resources/configuration/security", "/swagger-ui.html", "/webjars/**").permitAll()
.and()
.authorizeRequests()
.anyRequest()
.authenticated()
.and()
.csrf().disable();
}
답변
이 페이지에는 답이 있지만 모두 한곳에 없습니다. 나는 같은 문제를 다루고 있었고 그것에 대해 꽤 많은 시간을 보냈습니다. 이제 더 잘 이해했으며 여기에서 공유하고 싶습니다.
Spring 웹 보안으로 Swagger UI 활성화 :
기본적으로 Spring Websecurity를 활성화 한 경우 애플리케이션에 대한 모든 요청을 차단하고 401을 반환합니다. 그러나 swagger ui가 브라우저에로드하려면 swagger-ui.html은 데이터를 수집하기 위해 여러 번 호출합니다. 디버깅하는 가장 좋은 방법은 브라우저 (예 : Google 크롬)에서 swagger-ui.html을 열고 개발자 옵션 ( ‘F12’키)을 사용하는 것입니다. 페이지가로드 될 때 여러 호출이 수행되고 swagger-ui가 완전히로드되지 않으면 일부 호출이 실패하는 것을 볼 수 있습니다.
Spring websecurity에 여러 가지 경로 패턴에 대한 인증을 무시하도록 지시해야 할 수도 있습니다. 나는 swagger-ui 2.9.2를 사용하고 있으며 아래의 경우 무시해야 할 패턴이 있습니다.
그러나 다른 버전을 사용하는 경우 변경 될 수 있습니다. 이전에 말했듯이 브라우저의 개발자 옵션으로 자신을 찾아야 할 수도 있습니다.
@Configuration
public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter {
@Override
public void configure(WebSecurity web) throws Exception {
web.ignoring().antMatchers("/v2/api-docs", "/configuration/ui",
"/swagger-resources/**", "/configuration/**", "/swagger-ui.html"
, "/webjars/**", "/csrf", "/");
}
}
II 인터셉터로 Swagger UI 활성화
일반적으로 swagger-ui.html에서 만든 요청을 가로 채고 싶지 않을 수 있습니다. 아래 코드는 여러 패턴을 제외하는 것입니다.
웹 보안 및 인터셉터에 대한 대부분의 경우 패턴은 동일합니다.
@Configuration
@EnableWebMvc
public class RetrieveCiamInterceptorConfiguration implements WebMvcConfigurer {
@Autowired
RetrieveInterceptor validationInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(validationInterceptor).addPathPatterns("/**")
.excludePathPatterns("/v2/api-docs", "/configuration/ui",
"/swagger-resources/**", "/configuration/**", "/swagger-ui.html"
, "/webjars/**", "/csrf", "/");
}
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
인터셉터를 추가하려면 @EnableWebMvc를 활성화해야 할 수 있으므로 위의 코드 조각에서 수행 한 것과 유사한 리소스 처리기를 추가해야 할 수도 있습니다.
답변
Swagger 관련 리소스로만 제한 :
.antMatchers("/v2/api-docs", "/swagger-resources/**", "/swagger-ui.html", "/webjars/springfox-swagger-ui/**");