Please make either SecurityConfiguration#DEFAULT public or the default constructor public

Version: [2.6.1]

Issue

In 2.5.1, the springfox.documentation.swagger.web.SecurityConfiguration#DEFAULT field is public, as is shown here: https://github.com/springfox/springfox/blob/2.5.0/springfox-swagger-common/src/main/java/springfox/documentation/swagger/web/SecurityConfiguration.java#L26. However this was changed in 2.6.x. I’d like to know the reason why it has been changed. And if possible, please make it public again to accommodate the following use case.

Use case

Programmatically configure Swagger’s API key, example code in 2.5.0:

@EnableSwagger2
@Configuration
class SwaggerConfiguration {
    private ApiKey apiKey = null;

    @PostConstruct
    void init() {
        // some logic to assign apiKey according to some configuration
    }

    @Bean
    springfox.documentation.swagger.web.SecurityConfiguration security() {
        if (this.apiKey == null) {
            return springfox.documentation.swagger.web.SecurityConfiguration.DEFAULT;
        } else {
            return new springfox.documentation.swagger.web.SecurityConfiguration(null, null, null, null,
                    "Your access token", ApiKeyVehicle.HEADER, apiKey.getKeyname(), null);
        }
    }

Now 2.6.x in order to use the default security config, one needs to do the following, which is very cumbersome.

@EnableSwagger2
@Configuration
class SwaggerConfiguration {
    // This line is really cumbersome, and will potentially cause issues if the default parameters don't match with Swagger's.
    private static final springfox.documentation.swagger.web.SecurityConfiguration DEFAULT_SWAGGER_SECURITY_CONFIG = 
        new springfox.documentation.swagger.web.SecurityConfiguration(null, null, null, null, null, ApiKeyVehicle.HEADER, "api_key", ",");

    private ApiKey apiKey = null;

    @PostConstruct
    void init() {
        // some logic to assign apiKey according to some configuration
    }

    @Bean
    springfox.documentation.swagger.web.SecurityConfiguration security() {
        if (this.apiKey == null) {
            return springfox.documentation.swagger.web.SecurityConfiguration.DEFAULT;
        } else {
            return new springfox.documentation.swagger.web.SecurityConfiguration(null, null, null, null,
                    "Your access token", ApiKeyVehicle.HEADER, apiKey.getKeyname(), null);
        }
    }

Ideal Solution

Please make either of the following public:

• springfox.documentation.swagger.web.SecurityConfiguration#DEFAULT
• SecurityConfiguration’s default constructor

Or please advise other ways or workarounds.

Thanks!

[dilipkrish]

Closing this issue for now. We can reopen if you feel strongly after the 2.7.0 release

[bademux]

@dilipkrish We can use annotations like @NotNull with lombok. Or if more control is needed we can use factory method annotated with @Builder https://stackoverflow.com/questions/36909672/how-to-use-lombok-builder-annotation-on-methods