cannot integrate swagger springmvc using SwaggerSpringMvcPlugin

[ilya-martynov]

The problem is:
org.springframework.web.context.ContextLoader - Context initialization failed
org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'mySwaggerConfig': Injection of autowired dependencies failed; nested exception is org.springframework.beans.factory.BeanCreationException: Could not autowire field: private java.util.List com.mangofactory.swagger.configuration.SpringSwaggerConfig.handlerMappings; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type [org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping] found for dependency [collection of org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping]: expected at least 1 bean which qualifies as autowire candidate for this dependency. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}

MySwaggerConfig is the same in sample 'SwaggerSpringMvcPlugin XML Configuration'.
Spring config is:

<!-- The controllers are autodetected POJOs labeled with the @Controller annotation. -->
<context:component-scan base-package="com.mycompany.report" use-default-filters="false">
    <context:include-filter expression="org.springframework.stereotype.Controller" type="annotation"/>
</context:component-scan>

<!-- Turns on support for mapping requests to Spring MVC @Controller methods
     Also registers default Formatters and Validators for use across all @Controllers -->
<mvc:annotation-driven conversion-service="applicationConversionService"/>


<!-- Handles HTTP GET requests for /resources/** by efficiently serving up static resources -->
<mvc:resources location="/, classpath:/META-INF/web-resources/" mapping="/resources/**"/>

<!-- Allows for mapping the DispatcherServlet to "/" by forwarding static resource 
requests to the container's default Servlet -->
<mvc:default-servlet-handler/>

<!-- Register "global" interceptor beans to apply to all registered HandlerMappings -->
<mvc:interceptors>
    <bean class="org.springframework.web.servlet.theme.ThemeChangeInterceptor"/>
    <bean class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor" p:paramName="lang"/>
</mvc:interceptors>

<!-- Selects a static view for rendering without the need for an explicit controller -->
<mvc:view-controller path="/" view-name="index"/>
<mvc:view-controller path="/uncaughtException"/>
<mvc:view-controller path="/resourceNotFound"/>
<mvc:view-controller path="/dataAccessFailure"/>

<!--<bean class="com.mangofactory.swagger.configuration.SpringSwaggerConfig" />-->

<bean class="com.mycompany.report.config.MySwaggerConfig" />


<!-- Resolves localized messages*.properties and application.properties files in the application to allow for internationalization. 
The messages*.properties files translate Roo generated messages which are part of the admin interface, the 
application.properties resource bundle localizes all application specific messages such as entity names and menu items. -->
<bean class="org.springframework.context.support.ReloadableResourceBundleMessageSource" id="messageSource" p:basenames="WEB-INF/i18n/messages,WEB-INF/i18n/application" p:fallbackToSystemLocale="false"/>

<!-- Store preferred language configuration in a cookie -->
<bean class="org.springframework.web.servlet.i18n.CookieLocaleResolver" id="localeResolver" p:cookieName="locale"/>

<!-- Resolves localized <theme_name>.properties files in the classpath to allow for theme support -->
<bean class="org.springframework.ui.context.support.ResourceBundleThemeSource" id="themeSource"/>

<!-- Store preferred theme configuration in a cookie -->
<bean class="org.springframework.web.servlet.theme.CookieThemeResolver" id="themeResolver" p:cookieName="theme" p:defaultThemeName="standard"/>

<!-- This bean resolves specific types of exceptions to corresponding logical - view names for error views. 
The default behaviour of DispatcherServlet - is to propagate all exceptions to the servlet 
container: this will happen - here with all other types of exceptions. -->
<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver" p:defaultErrorView="uncaughtException">
    <property name="exceptionMappings">
        <props>
            <prop key=".DataAccessException">dataAccessFailure</prop>
            <prop key=".NoSuchRequestHandlingMethodException">resourceNotFound</prop>
            <prop key=".TypeMismatchException">resourceNotFound</prop>
            <prop key=".MissingServletRequestParameterException">resourceNotFound</prop>
        </props>
    </property>
</bean>

<!-- Enable this for integration of file upload functionality -->
<bean class="org.springframework.web.multipart.commons.CommonsMultipartResolver" id="multipartResolver"/>

/WEB-INF/layouts/layouts.xml /WEB-INF/views/**/views.xml

There are no issues to use by 'quick guide(Spring xml Configuration)' of docs, but when I try to use custom config I got the error. Could you please help me to resolve the problem?

[dilipkrish]

@MagnusMagister this seems like a similar issue

[ilya-martynov]

@dilipkrish yeah thanks a lot for the reply! Seems but I'm not sure the same. You know if I remove @configuration annotation of MySwaggerConfig (just keep @EnableSwagger) it works fine without any errors.

[jyoung]

I was having the same problem and am using the XML configuration.
I removed the @configuration attribute from my SwaggerConfig and it worked fine.

[ilya-martynov]

@jyoung Yes. It works without it. But why? Is this the conflict between annotations? Because SpringSwaggerConfig class contains @configuration already.

[jyoung]

@MagnusMagister Good question and honestly I don't know why. I have been racking my head just trying to make it work predictably and that was the missing piece for me.

[dilipkrish]

@MagnusMagister @jyoung Possibly a race condition. Quick googling lead me to this

[lucjross]

I'm also struggling with this issue. I have no XML config, only Java. I'm using Spring 4.1.4, Spring-Boot 1.2.0, and swagger-springmvc 0.9.4.

[dilipkrish]

@lucjross that's not much info to be able to help you. Have you looked at the demo project? It contains a number of examples using both spring web mvc and spring-boot.

[lucjross]

I did as @MagnusMagister suggested to my empty SwaggerConfig class and it simply removed Swagger from the bean configuration. I think I may have resolved the issue for myself by adding @Import(SwaggerConfig.class) to my main app class, which itself has @Configuration. Not sure what's going on but I hope that helps.

[ericsodt]

I seem to be running into similar issues described here, however separating the swagger config from the MVC config doesn't seem to be fixing our problem.

If I comment out the @Import statement, then our application runs normally with all services starting up correctly. However, when it is uncommented I get the following:

Caused by: java.lang.IllegalStateException: Cannot map handler 'projectController' to URL path [/heartbeat]: There is already handler of type [class ...FormMVCController] mapped.
...

Below is the configuration files we are using:

Config.java

@Configuration
@ComponentScan("my.pkg")
@EnableMvc
@PropertySources({
    @PropertySource("/WEB-INF/resources/path/to/file")
 })
@Import(SwaggerConfig.class)

public class Config extends WebMvcConfigurerAdapter {

   @Override
   public void configureMessageConverters (List<..> converters) {}

  @Override
   public void addResourceHandlers (ResourceHandlerResistry reg) {
       reg.addResourceHandler("/css/**").addResourceLocations("css/");
       reg.addResourceHandler("/fonts/**").addResourceLocations("fonts/");
       reg.addResourceHandler("/img/**").addResourceLocations("img/");
       reg.addResourceHandler("/js/**").addResourceLocations("js/");
   }

  @Override
  public void configureDefaultServletHanding(DefaultServletHandlerConfigurer conf) {
     conf.enable();
  }

  @Bean
  public InternalResourceViewResolver getInternalResourceViewResolver() {
     InternalResourceViewResolver resolver = new InternalResourceViewResolver ();
     resolver.setPrefix("/WEB-INF/jsp/");
     resolver.setSuffix(".jsp");
     return resolver;
  }

   @Bean
   public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() {
        return new PropertySourcesPlaceholderConfigurer();
   }
}

WebApp.java

public class WebApp implements WebApplicationInitializer, ApplicationContextAware {

    private ApplicationContext context;

   @Override
   public void setApplicationContext(ApplicationContext context) {
       this.context = context;
   }
    @Override
   public void onStartup(ServletContext sc) {
       AnnotationConfigWebApplicationContext ctx  = new AnnotationConfigWebApplicationContext();
       ctx.register(Config.class);
       ctx.setServletContext(sc);

       DispatcherServlet ds = new DispatcherServlet(ctx);
       Dynamic servlet = sc.addServlet("dispatcher", ds);
       servlet.addMapping("/services/*");
       servlet.setLoadOnStarup(1);
   }

  @Bean
  //  RestTemplate creation below
}

SwaggerConfig.java

// commented out as requested below
//@PropertySource("classpath:swagger.properties")
@EnableSwagger2
public class SwaggerConfig {
   //@Value("${springfox.documentation.swagger.vs.path}")
   //private String swagger2Endpoint

   //@Value("${springfox.documentation.swagger.v1.path}")
  // private String swagger1Endpoint
}

SampleController.java

@RestController
@RequestMapping("/test")
public class SampleController {
    @RequestMapping(value="one", method=RequestMethod.GET, produces = {..JSON, .. XML})
    public @ResponseBody ControllerApi getTest() {
        return "test";
    }
}

Any thoughts on what might be causing this issue?

[dilipkrish]

Based on the error

Caused by: java.lang.IllegalStateException: Cannot map handler 'projectController' to URL path [/heartbeat]: There is already handler of type [class ...FormMVCController] mapped.

It seems like you have two controllers with request mappings /heartbeat.

[ericsodt]

@dilipkrish, I agree and when looking through the controller code I see all controllers extends from Abstract BaseController that contains the 'heartbeat' method. From what I'm seeing Spring allows this and can service responses when calling the 'heartbeat' service. We only run into the issue when integrating with springfox. This might be a good usecase for another issue?

With regards to the controller mappings. I commented out the method and the stacktrace goes away, however our application still isn't starting properly. It looks as though I am missing a configuration file that should contain "springfox.documentation.swagger.v2.path:/v2/api-docs". I followed the instructions here but looks as though I am missing something since I am still getting

DefaultAnnotationHandlerMapping.registerHandler Mapped URL path [$springfox.documentation.swagger.v2.path:/v2/api-docs}] onto handler 'swagger2Controller'

Just to clarify. I created 'swagger.properties' under /src/main/resources and its contents are:

springfox.documentation.swagger.v2.path=localhost:8080/myProject/api

[dilipkrish]

@ericsodt You don't need a config file for that, it has a default value already set. Try removing any PropertySourcesPlaceholderConfigurer or PropertyPlaceholderConfigurer beans that you may have defined.