Swagger-UI с Spring безопасности - PullRequest
Новая
       26

Swagger-UI с Spring безопасности

0 голосов
/ 19 ноября 2018

У меня есть простое приложение REST с сервисом аутентификации.Я пытался добавить к нему swagger и swagger-ui, но мои конечные точки я вижу только в /v2/api-docs.В swagger-ui.html я вижу только группы конечных точек, но не могу расширить какой-либо список.

В отладке Chrome я вижу:

Не удалось загрузить ресурс: сервер ответил сстатус 401 ()

Uncaught TypeError: Невозможно прочитать свойство 'indexOf' с неопределенным

и на терминале с сервером:

ОШИБКА 10020--- [nio-5001-exec-3] ctrapJwtAuthenticationEntryPoint: Ответ с несанкционированной ошибкой.Сообщение - для доступа к этому ресурсу требуется полная аутентификация

Похоже, в моих конфигурационных файлах чего-то не хватает, я пробовал несколько решений, которые нашел в сети, но все равно ничего не работает.

Этомой код:

pom 

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

контроллер 

@RestController
@PreAuthorize("hasRole('USER')")
@RequestMapping(path = "restaurant")
@Api(value="restaurant", description="Example operations for restaurants")
public class RestaurantController {
// endpoints
}

боб Swagger 

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.tablebooker.restaurantservice.restaurant"))
                .paths(PathSelectors.any())
                .build();
    }
}

SecurityConfig 

@Configuration
@EnableWebSecurity
@EnableGlobalMethodSecurity(
        securedEnabled = true,
        jsr250Enabled = true,
        prePostEnabled = true
)
public class SecurityConfig extends WebSecurityConfigurerAdapter {
//other methods

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
                .cors()
                .and()
                .csrf()
                .disable()
                .exceptionHandling()
                .authenticationEntryPoint(unauthorizedHandler)
                .and()
                .sessionManagement()
                .sessionCreationPolicy(SessionCreationPolicy.STATELESS)
                .and()
                .authorizeRequests()
                .antMatchers("/",
                        "/favicon.ico",
                        "/**/*.png",
                        "/**/*.gif",
                        "/**/*.svg",
                        "/**/*.jpg",
                        "/**/*.html",
                        "/**/*.css",
                        "/**/*.js")
                .permitAll()
                .antMatchers("/api/auth/**")
                .permitAll()
                .antMatchers("/restaurant/**")
                .hasRole("USER")
                .anyRequest()
                .authenticated();

        http.addFilterBefore(jwtAuthenticationFilter(), UsernamePasswordAuthenticationFilter.class);

    }

    @Override
    public void configure(WebSecurity web) throws Exception {
        web.ignoring().antMatchers("/v2/api-docs", "/configuration/ui", "/swagger-resources", "/configuration/security", "/swagger-ui.html", "/webjars/**");
    }
}

Любые идеи, как я могу заставить мою конфигурацию работать?

Ответы [ 2 ]

0 голосов
/ 06 декабря 2018

Для меня не было никаких проблем в традиционном развертывании Weblogic без какого-либо упоминания о @Override public void configure(WebSecurity web) throws Exception ... Достаточно было только @Override protected void configure(HttpSecurity http) throws Exception, и пользовательский интерфейс был виден на чванстве.

Но тот же код не работал на сервере Apache Tomcat, поэтому необходим следующий код:

@Override public void configure(WebSecurity web) throws Exception { web.ignoring().mvcMatchers(HttpMethod.OPTIONS, "/**"); // ignore swagger web.ignoring().mvcMatchers("/swagger-ui.html/**", "/configuration/**", "/swagger-resources/**", "/v2/api-docs","/webjars/**"); }

/webjars/** отсутствует в ответе AokoQin.

Ответ здесь, потому что я не сталкивался с какими-либо проблемами в Weblogic без вышеуказанного кода, а только с Tomcat.У меня уже есть ресурсы, добавленные через ResourceHandlerRegistry в конфигурации MVC.

0 голосов
/ 20 ноября 2018

Сначала вы должны использовать ресурсы реестра Swagger. 

@Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {


    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
    }
}

Затем, поскольку вы используете Spring Security, возможно, вам следует отключить привилегии. 

   @Override
    public void configure(WebSecurity web) throws Exception {
        web.ignoring().mvcMatchers(HttpMethod.OPTIONS, "/**");
        // ignore swagger 
        web.ignoring().mvcMatchers("/swagger-ui.html/**", "/configuration/**", "/swagger-resources/**", "/v2/api-docs");
    }

И, возможно, вам лучшеиспользуйте чванство, версия которого ниже 2.8.0, или вам, возможно, придется столкнуться с множеством ошибок.

...