web-dev-qa-db-fra.com

UI Spring Boot & Swagger. Définir le jeton JWT

J'ai une configuration Swagger comme celle-ci

@EnableSwagger2
@Configuration
public class SwaggerConfig {
    @Bean
    public Docket api() {
        List<SecurityScheme> schemeList = new ArrayList<>();
        schemeList.add(new ApiKey(HttpHeaders.AUTHORIZATION, "JWT", "header"));
        return new Docket(DocumentationType.SWAGGER_2)
                .produces(Collections.singleton("application/json"))
                .consumes(Collections.singleton("application/json"))
                .ignoredParameterTypes(Authentication.class)
                .securitySchemes(schemeList)
                .useDefaultResponseMessages(false)
                .select()
                .apis(Predicates.not(RequestHandlerSelectors.basePackage("org.springframework.boot")))
                .paths(PathSelectors.any())
                .build();
    }
}

Lorsque je clique sur le bouton Autoriser dans l'interface utilisateur Swagger, j'entre mon jeton JWT dans le champ de valeur eyJhbGc..nN84qrBg. Maintenant, je m'attends à ce que toute demande que je fais via l'interface utilisateur Swagger contienne le JWT dans l'en-tête. Cependant, ce n'est pas le cas… .. Aucune demande ne contient d'en-tête d'autorisation.

Qu'est-ce que je rate?

spring-bootswaggerswagger-uiswagger-2.0
5
isADon

La prise en charge de l'en-tête Authorization: Bearer [JWT_TOKEN] fonctionne à partir de la version 2.9.2.

Ajout des dépendances suivantes à build.gradle

compile("io.springfox:springfox-swagger2:2.9.2") {
    exclude module: 'mapstruct' // necessary in my case to not end up with multiple mapstruct versions
}
compile "io.springfox:springfox-bean-validators:2.9.2"
compile "io.springfox:springfox-swagger-ui:2.9.2"

Swagger configuré via

@Configuration
@EnableSwagger2
@Import(springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration.class)
public class SwaggerConfiguration {

    public static final String AUTHORIZATION_HEADER = "Authorization";
    public static final String DEFAULT_INCLUDE_PATTERN = "/api/.*";
    private final Logger log = LoggerFactory.getLogger(SwaggerConfiguration.class);

    @Bean
    public Docket swaggerSpringfoxDocket() {
        log.debug("Starting Swagger");
        Contact contact = new Contact(
            "Matyas Albert-Nagy",
            "https://justrocket.de",
            "[email protected]");

        List<VendorExtension> vext = new ArrayList<>();
        ApiInfo apiInfo = new ApiInfo(
            "Backend API",
            "This is the best stuff since sliced bread - API",
            "6.6.6",
            "https://justrocket.de",
            contact,
            "MIT",
            "https://justrocket.de",
            vext);

        Docket docket = new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo)
            .pathMapping("/")
            .apiInfo(ApiInfo.DEFAULT)
            .forCodeGeneration(true)
            .genericModelSubstitutes(ResponseEntity.class)
            .ignoredParameterTypes(Pageable.class)
            .ignoredParameterTypes(Java.sql.Date.class)
            .directModelSubstitute(Java.time.LocalDate.class, Java.sql.Date.class)
            .directModelSubstitute(Java.time.ZonedDateTime.class, Date.class)
            .directModelSubstitute(Java.time.LocalDateTime.class, Date.class)
            .securityContexts(Lists.newArrayList(securityContext()))
            .securitySchemes(Lists.newArrayList(apiKey()))
            .useDefaultResponseMessages(false);

        docket = docket.select()
            .paths(regex(DEFAULT_INCLUDE_PATTERN))
            .build();
        watch.stop();
        log.debug("Started Swagger in {} ms", watch.getTotalTimeMillis());
        return docket;
    }


    private ApiKey apiKey() {
        return new ApiKey("JWT", AUTHORIZATION_HEADER, "header");
    }

    private SecurityContext securityContext() {
        return SecurityContext.builder()
            .securityReferences(defaultAuth())
            .forPaths(PathSelectors.regex(DEFAULT_INCLUDE_PATTERN))
            .build();
    }

    List<SecurityReference> defaultAuth() {
        AuthorizationScope authorizationScope
            = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        return Lists.newArrayList(
            new SecurityReference("JWT", authorizationScopes));
    }
}

Accéder à l'interface utilisateur via http://Host:port/<context-root>/swagger-ui.html

Appuyez sur Autoriser toutes les demandes et entrez Bearer [JWT_TOKEN].

 Press authorize then enter the Bearer JWT Token

Voila vos prochaines requêtes auront l'en-tête JWT

 enter image description here

7
Matyas

Votre code est correct. 

Il y a un bug dans springfox-swagger-ui / springfox-swagger2 version 2.8.0 et il semble bien que ce soit 2.9.2 également. Je suppose que vous utilisez une version affectée par ce bogue.

J'ai simplement rétrogradé à 2.7.0 et cela a parfaitement fonctionné.

1
rjdkolb