Api key input missing in swagger ui after upgrading version to 2.6.1

[prajapatkiran]

I have a spring boot application which uses swagger. The project runs absolutely fine in swagger version 2.5.0. I had to update the swagger version to v2.6.1 to get @ApiIgnore working for some new requirement. After I upgraded the version I dont see api_key input field in swagger-ui.
Below is my project configuration:

I tried with both 2.6.1 and 2.7.0-SNAPSHOT. Here are the dependencies
pom.xml

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

SwaggerConfig.java

@Bean
public Docket newsApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.basePackage("some.package"))
            .paths(PathSelectors.any())
            .build()
            .pathMapping("/")
            .produces(Sets.newHashSet(APPLICATION_JSON_VALUE))
            .consumes(Sets.newHashSet(APPLICATION_JSON_VALUE))
            .directModelSubstitute(LocalDateTime.class, Date.class)
            .directModelSubstitute(OffsetDateTime.class, Date.class)
            .directModelSubstitute(Instant.class, Date.class)
            .directModelSubstitute(HttpStatus.class, String.class)
            .apiInfo(apiInfo())
            .useDefaultResponseMessages(false);
}
@Bean
SecurityConfiguration security() {
    return new SecurityConfiguration(
            null,
            null,
            null, // realm Needed for authenticate button to work
            null, // appName Needed for authenticate button to work
            BEARER,// apiKeyValue
            ApiKeyVehicle.HEADER,
            AUTHORIZATION, //apiKeyName
            null);
}

MvcConfig.java

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    super.addResourceHandlers(registry);
    //Adding swagger-ui webjars resources mapping so swagger-ui can be served
    if (!registry.hasMappingForPattern("/webjars/**")) {
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
    if (!registry.hasMappingForPattern("/swagger-ui.html")) {
        registry.addResourceHandler("/swagger-ui.html").addResourceLocations(
                "classpath:/META-INF/resources/");
    }
}

[dilipkrish]

The API key is configured via the security bean. Where you have BEARER, it should be BEARER KEY....

[prajapatkiran]

That is something which we expect the user to enter in swagger ui. Bearer is the default value which shows up in the text box. My issue is that after changing the swagger version I dont see the input text box at all.
Please see snapshot below.

Before upgrade:

After upgrade:

[ThatsOurJake]

This too is happening to me, before version 2.7 the input box would appear, now the input box isn't no longer renders but the security is still applied

[dilipkrish]

When we upgrade to 3.x of swagger-ui we'll address this

[KhushbooRathi]

Hi,
We need this this oAuth functionality in our project. Will you please let me know when the stable version of swagger 3.0 is released?

Thanks,
Khushboo

[dilipkrish]

Not sure at the moment. Sometime in the next couple of months

[ngawor]

I am now hitting other swagger bugs due to do my inability to upgrade in order to keep token support. This fix is very important to us.

[dilipkrish]

@ngawor What fix are you referring to. This is a question targeting 2.6.1 version of this library.

[ngawor]

@dilipkrish I have yet to find a version higher than 2.5 that will allow the Bearer token to be passed successfully. Are you saying that exists?

[dilipkrish]

@ngawor I'm not sure, so I trust your observation that this is an issue with 2.7.0. I'll change this ticket to a bug instead. I'd like some help/pointers on what needs to happen to get this resolved. A PR would be very welcome.

[harrygu]

I would like to express that this is a critical bug to fix. Without the fix, I cannot upgrade to any version above 2.5 because the newer versions do not allow us to get over api key-based authentication.

[dilipkrish]

This has been fixed via upgrading to swagger ui 3.x (#2153)

[harrygu]

@dilipkrish Could you please give an example for how to enable the Api Key field at the top of the screen in 2.8.0? It seems there have been lots of changes in the new release.

[batizhao]

@dilipkrish The 2.8.0 version seems to be a problem. Where did I make a mistake?

2.6.0

This version is ok.

Java code

@Bean
public Docket api() {
   return new Docket(DocumentationType.SWAGGER_2)
           .select()
           .apis(RequestHandlerSelectors.basePackage("sh.ideal.ims.controller"))
           .paths(PathSelectors.any())
           .build()
           .apiInfo(apiInfo())
           .securitySchemes(Collections.singletonList(apiKey()));
}

private ApiKey apiKey() {
    return new ApiKey("Authorization", "Bearer", "header");
}

Input at swagger-ui

name: Authorization
in: header
value: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6

curl at swagger-ui

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6' 'http://localhost:8001/user'

Update to 2.7.0

This version is ok. BUT name and keyname, need a change of location

Java code

private ApiKey apiKey() {
    return new ApiKey("Bearer", "Authorization", "header");
}

2.8.0

Java code

private ApiKey apiKey() {
    return new ApiKey("Bearer", "Authorization", "header");
}

This version --header 'Bearer: AAA' missing in swagger ui.
See curl at swagger-ui

Please help me, Thanks.

[dilipkrish]

@batizhao Just checking, did you click the lock icon in the API and configure the API to be protected?

[batizhao]

spring-boot 1.5.9.RELEASE

Java Code

@ApiOperation(value = "xxxxxxx")
@ApiImplicitParam(name = "p", value = "Page No.", dataType = "int", paramType = "query")
@GetMapping()
@PreAuthorize("hasRole('SUPER_ADMIN')")
public RestResponse list(@RequestParam(value = "p", required = false, defaultValue = "1") int pageNum) {
    Page<User> users = userService.findUsers(pageNum);
    return new RestResponse<>(users);
}

application.yml

security:
  basic:
    enabled: false
  oauth2:
    resource:
      jwt:
        keyValue: |
          -----BEGIN PUBLIC KEY-----
          XXXXXXXX
          -----END PUBLIC KEY-----

  ignored: /v2/api-docs,/swagger-resources/**,/swagger-ui.html,/webjars/**,/configuration/ui,/configuration/security

Step 1. Click Button "Authorize"
Step 2. input value "Bearer XXX"
Step 3. Click Button "Authorize",
Step 4. Click "Done".
Step 5. Try it.

--header 'Authorization: Bearer XXX' missing.

[jbforth4]

Is there an update on this? We want to use the new 2.8 version but cannot get it to work with OAuth.

[dilipkrish]

It should be fixed in 2.9.0, if not please report back @jbforth4

[spamovy]

@dilipkrish still not working in 2.9.0!

[dilipkrish]

@spamovy This may be a bug in swagger-ui. Is this reproducible using the the demos project?

[BartoszCoyote]

still no working.

[dilipkrish]

@BartoszCoyote please create a new issue. 2.6.1 and 2.9.2 have different versions of swagger-ui

[medialwerk]

We have the same problem with version 2.9.2. I just opened a issue for this version.