How to Set Up a Redirect in OpenApi 3 with Spring Boot 3 from Root to Swagger UI

Discover how to effortlessly redirect from the root URL of your Spring Boot application to the Swagger UI page, enhancing your API documentation accessibility with OpenApi 3.
---

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
How to Set Up a Redirect in OpenApi 3 with Spring Boot 3 from Root to Swagger UI

The Problem

Here's the problematic code snippet that demonstrates this issue:

[[See Video to Reveal this Text or Code Snippet]]

This method gets triggered but results in showing the endpoint "/" on the OpenAPI page, which is not desirable.

The Solution

Step-by-Step Instructions

Add the following property:

[[See Video to Reveal this Text or Code Snippet]]

What This Property Does

Benefits of This Approach

Simplicity: No need to manage controller redirects explicitly.

Clean API Documentation: Avoids exposing unnecessary endpoints in your OpenAPI documentation.

Convenience: Provides a straightforward way for developers to access API documentation without additional effort.

Conclusion

Implementing this solution simplifies your workflow and leads to better API management. Enjoy creating well-documented APIs with ease!