swagger2 not working with Spring REST

Question

I have a spring application whose web.xml looks like below:

<servlet>
  <servlet-name>app</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/app-servlet.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>app</servlet-name>
        <url-pattern>*.html</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>app</servlet-name>
        <url-pattern>/service/*</url-pattern>
    </servlet-mapping>

Inside my app-servlet.xml I have the below config entry:

<context:component-scan base-package="com.rest.apidoc" />

I have my SwaggerConfig inside the com.rest.apidoc directory

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

Now when I try to run the app http://domain:port/app/service/api-docs, I get the error on my console No mapping found for HTTP request with URI [/app/service/api-docs] in DispatcherServlet with name 'app'

Where am I going wrong?

score 1 · Answer 1 · answered Jun 20 '17 at 09:28

There is few things that may go wrong:

you don't register appropriate resource handlers. example
you may hit the wrong url. "app" is only a servlet name, doesn't need to appear in url. servlet-mapping
if you've registered resource handlers correctly and included springfox-swagger-ui dependency in your project, you need to request "http://domain:port/service/swagger-ui.html" to see API documented with swagger.

Refer to the following project to check whether you've configured your application correctly: Spring Security for REST Example Project

swagger2 not working with Spring REST

1 Answers1