在 Spring 的 Swagger UI 上接收 404 错误

Question

I am integrating with swagger UI with Spring boot application. When I hit the swagger-ui.html. I am getting the 404 error. My config class is below:

@Configuration
@EnableSwagger2
//@Import(SwaggerConfiguration.class)
public class SwaggerConfig  {
    @Bean
        public Docket api() {
            return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
        }
...

Error message:

{"status":404,"message":"HTTP 404 Not Found","link":"https://jersey.java.net/apidocs/2.8/jersey/javax/ws/rs/NotFoundException.html"}

Answer 1

I had a similar problem where /swagger-ui.html (or the new endpoint version /swagger-ui/) returned 404, but the /v2/api-docs returned a valid json. The solution was to downgrade the swagger version from 3.0.0. to 2.9.2.

Answer 2

Hope this helps, please find my working swagger config below:

@Configuration
@EnableSwagger2
@Profile({"!production"})
public class SwaggerConfiguration extends WebMvcConfigurerAdapter {

    @Autowired
    private ServletContext servletContext;


    @Bean
    public Docket api() {

        return new Docket(DocumentationType.SWAGGER_2)
                .host("localhost")
                .directModelSubstitute(LocalDate.class, Date.class)
                .pathProvider(new RelativePathProvider(servletContext) {
                    @Override
                    public String getApplicationBasePath() {
                        return "/";
                    }
                })
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

Answer 3

I had the same problem and it was fixed by replacing the springfox-swagger2 and springfox-swagger-ui dependencies with springfox-boot-starter:3.0.0 and removing the @EnableSwagger2 annotation. Please note that the Swagger url also changes from http://localhost:8080/swagger-ui.html to http://localhost:8080/swagger-ui/index.html.

Answer 4

Do you have @EnableWebMvc in one of your configuration classes? If so, you will have to do the resources configuration manually, like below:

@Override
public void addResourceHandlers (ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/swagger-ui.html**")
            .addResourceLocations("classpath:/META-INF/resources/swagger-ui.html");
    registry.
            addResourceHandler("/webjars/**")
            .addResourceLocations("classpath:/META-INF/resources/webjars/");
}

Answer 5

如果您使用版本 > 3，只需使用/swagger-ui/而不是swagger-ui.html

Answer 6

Please invite following dependence into pom.xml

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

Answer 7

I had an almost similar issue in spring-boot using the springfox-boot-starter:3.0.0 where swagger UI would come as empty and looking at the console it was throwing 404

http://{ip}:{port}/custom/url/swagger-ui/index.html/swagger-ui-bundle.js?v=3.0.0 net::ERR_ABORTED 404

The error was the "/" that I was adding at the end of the documentation URL

I was writing "http://{ip}:{port}/custom/url/swagger-ui/index.html/"

Instead of

"http://{ip}:{port}/custom/url/swagger-ui/index.html"

Note the "/" at the end