Api key header field is missing in swagger ui calls (version 2.9.2)

Version: 2.9.2

Hello everybody,

this bug report is refering to https://github.com/springfox/springfox/issues/1804. It seems that the header field (here: api_key) is missing in the swagger ui calls. We see it for example at the generated curl commands (examples are below).

Java code

public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
            .paths(PathSelectors.regex(Constants.REST_API_PATH_ROOT + ".*"))
            .build()
            .securitySchemes(Arrays.asList(apiKey()))
            .useDefaultResponseMessages(false);

    }

    private ApiKey apiKey() {
        return new ApiKey("APIKey", "api_key", "header");
    }
}

Input at swagger-ui

name: APIKey
in: header
value: my_key_value

curl at swagger-ui (current behaviour)

curl -X GET "http://localhost:8080/api/users" -H "accept: application/json"

curl at swagger-ui (expected behaviour)

curl -X GET "http://localhost:8080/api/users" -H 'Accept: application/json' -H 'api_key: my_key_value' 

Thank you very much for your help!

[tholu]

@medialwerk I had the same issue, you are missing this in the return of your api() method after .build():

.securityContexts(Collections.singletonList(securityContext()))

The references methods need to be like this:

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

  private List<SecurityReference> defaultAuth() {
    final AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
    final AuthorizationScope[] authorizationScopes = new AuthorizationScope[]{authorizationScope};
    return Collections.singletonList(new SecurityReference("api_key", authorizationScopes));
  }```

[medialwerk]

Thank you very much! 😃. That was the missing part! 😃.

I only had to change api_key to APIKey in your code sample:

  private List<SecurityReference> defaultAuth() {
    final AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
    final AuthorizationScope[] authorizationScopes = new AuthorizationScope[]{authorizationScope};
    return Collections.singletonList(new SecurityReference("APIKey", authorizationScopes));
  }