Spring springdoc-openapi : swagger-ui/index.html cannot be found status=404

Question

I've a spring boot application (2.5.6) with a dependency on springdoc-openapi. However, launching swagger-ui (http://localhost:8080/v1/swagger-ui/index.html) doesn't work. The debug logs are indicating that index.html is not present. What could be the reason that index.html is not found ?

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.6.8</version>
</dependency>

application.yaml

springdoc:
  swagger-ui:
    tagsSorter: alpha
    operations-sorter: alpha
    doc-expansion: none
    disable-swagger-default-url: true

logging:
  level:
    root: DEBUG

server:
  port: 8080

spring:
  application:
    name: fe-applic-app
    api-version: "v1"

user2023141 · Accepted Answer · 2022-05-20 12:38:46Z

10

I found the cause of the problem. The context-path was not set in application.yaml.

http://localhost:8080/v1/swagger-ui/index.html

After adding servlet : context-path, swagger-ui is rendered

server:
  port: 8080
  servlet:
    context-path: "/${spring.application.api-version}"

answered May 20, 2022 at 12:38

user2023141

1,2636 gold badges24 silver badges47 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Aditzu Over a year ago

awesome, great answer, fixed my problem. Based on this I added something similar in my application.properties spring.application.api-version=v1 server.servlet.context-path=/${spring.application.api-version}

Matthieu Saleta · Accepted Answer · 2023-10-18 09:57:35Z

9

To share my experience because I have just spend more than 1 day to resolve a similar problem.

This can happen if the project contains a configuration class extending WebMvcConfigurationSupport.

To be more precise :

The /v3/api-docs route was working
The /swagger-ui/index.html was throwing a 404 error

As I said, we had inside the project a configuration class extending WebMvcConfigurationSupport in order to automatically convert lowercase String inside the request to an uppercase Enumeration (How to make enum parameter lowercase in SpringBoot/Swagger?)

In this case, Spring creates first a bean extending WebMvcConfigurationSupport where the addResourceHandlers(ResourceHandlerRegistry) method does nothing (Empty method).

When this configuration class is not present, Spring creates a bean DelegatingWebMvcConfiguration extending WebMvcConfigurationSupport but this class overrides the addResourceHandlers(ResourceHandlerRegistry) method to register all the WebMvcConfigurer beans to the ResourceHandlerRegistry.

So it adds the SwaggerWebMvcConfigurer that manages the route swagger-ui/index.html.

answered Oct 18, 2023 at 9:57

Matthieu Saleta

1,5281 gold badge14 silver badges18 bronze badges

2 Comments

raphael Over a year ago

This was the cause of the problem for me, thank you! I solved it by refactoring the class that extended WebMvcConfigurationSupport to implement WebMvcConfigurer instead.

Selim Ok Over a year ago

Thank you very much, this answer saved many hours of my life :)

Grim · Accepted Answer · 2022-05-20 11:40:38Z

4

Try swagger-ui.html instead of swagger-ui/index.html. In 60% of the cases swagger-ui.html redirects to its real location.

http://localhost:8080/v1/swagger-ui.html http://localhost:8080/v3/swagger-ui.html

answered May 20, 2022 at 11:40

Grim

2,13312 gold badges63 silver badges138 bronze badges

Comments

hamidreza75 · Accepted Answer · 2022-10-29 07:35:32Z

3

add this to your configs:

@Configuration
public class WebAppConfig extends WebMvcConfigurationSupport
{

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

see source and static-resources

edited Oct 29, 2022 at 7:35

answered Oct 29, 2022 at 7:29

hamidreza75

7171 gold badge7 silver badges20 bronze badges

Comments

Vikas s kumar · Accepted Answer · 2023-09-11 20:09:41Z

1

If you are using open API with spring 3. It will give 404 error. Hence use the springdoc-openapi-starter-webmvc-ui dependency. Later you can use the URL's

http://localhost:8080/v3/api-docs
http://localhost:8080/swagger-ui/index.html

Eg

    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
        <version>2.1.0</version>
    </dependency>

answered Sep 11, 2023 at 20:09

Vikas s kumar

3353 silver badges3 bronze badges

Comments

simo · Accepted Answer · 2025-02-06 14:05:22Z

0

Even though I'm dealing with a newer version of springboot I had exactly the same issue with a specific version of SpringBoot

Spring boot 3.2.10 (with springdoc 2.6.0) was working, showing the swagger page
Spring boot 3.4.2 (with springdoc 2.7.x or 2.8.x) wasn't showing the page

I was blaming the newer version of springboot, but there was probably something wrong with my maven cache. I delete all the org.spring* stuff and this fixed the issue. If this didn't work, I would also suggest cleaning all the IDE caches.

answered Feb 6 at 14:05

simo

3734 silver badges11 bronze badges

Collectives™ on Stack Overflow

Spring springdoc-openapi : swagger-ui/index.html cannot be found status=404

6 Answers 6

1 Comment

2 Comments

Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

1 Comment

2 Comments

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related