Springfox swagger2 @Component does not get indexed by Spring Framework 5 `spring-context-indexer`

Springfox Swagger Version

2.8.0

Spring Boot Version

2.0.2.RELEASE

Description

When using component-indexer with springfox-swagger2, the application fails to start.

Error:

Parameter 2 of method swagger2ControllerMapping in springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration 
required a bean of type 'springfox.documentation.swagger2.mappers.ServiceModelToSwagger2Mapper' 
that could not be found.

Test case

https://github.com/ssouris/swagger-component-indexer-bug

[mhyeon-lee]

@Diagoras

I mean, For compatibility with spring-context-indexer, the Swagger configuration should be modified.

@Configuration
@Import({ SpringfoxWebMvcConfiguration.class, SwaggerCommonConfiguration.class })
//  TODO: remove below: componentScan of external library does not work when using spring-context-indexer. 
//  @ComponentScan(basePackages = { 
//     "springfox.documentation.swagger2.mappers"
//  })   
//   
@ConditionalOnWebApplication
public class Swagger2DocumentationConfiguration {
 
    // TODO:  Add all the @Components under "springfox.documentation.swagger2.mappers" as beans.
     @Bean
     public ModelMapper modelMapper() {
         return new ModelMapperImpl();
     }  

     @Bean
     public ParameterMapper parameterMapper() {
         return new ParameterMapperImpl();
     }  

     @Bean
     public SecurityMapper securityMapper() {
         return new SecurityMapperImpl();
     }  

     @Bean
     public LicensMapperImpl licenseMapper() {
         return new LicenseMapperImpl();
     }
   
     @Bean
     public  VendorExtensionMapper vendorExtensionMapper() {
          return new VendorExtensionsMapperImpl();  
     }

    @Bean
  public ServiceModelToSwagger2Mapper serviceModelToSwagger2Mapper(
     ModelMapper modelMapper,
     ParameterMapper parameterMapper,
     SecurityMapper securityMapper,
     LicenseMapper licenseMapper,
     VendorExtensionMapper vendorExtensionMapper) {
          return new ServiceModelToSwagger2MapperImpl(modelMapper, parameterMapper, securityMapper, licenseMapper, vendorExtensionMapper);
     }
}

In addition, @Components under the following packages may require @Bean registration.

• SpringfoxWebMvcConfiguration.java

  springfox.documentation.spring.web.scanners springfox.documentation.spring.web.readers.operation springfox.documentation.spring.web.readers.parameter springfox.documentation.spring.web.plugins springfox.documentation.spring.web.paths

• ModelConfiguration

  springfox.documentation.schema

• SwaggerCommonConfiguration

  springfox.documentation.swagger.schema springfox.documentation.swagger.readers springfox.documentation.swagger.web

---

I hope to fix this setting in swagger.

Otherwise, all @Components in the above package must be registered by the developer directly with @Bean.

[wreulicke]

@dilipkrish cc: @ssouris @nathanmauro I wrote a PR for this issue. Could you review it?

https://github.com/springfox/springfox/pull/2971