How to Add OpenApi (Swagger) for Documenting a Spring REST API

In this post, I will show you how to add Swagger OpenAPI support to the Spring Boot project so that you can start documenting your REST API.

Preliminary

This post is a continuation of the previous article…

Custom JSON Response with ResponseEntity in Spring Boot

Steps

• Add this to your pom.xml

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

Next, build and run. You can access this to look the OpenAPI descriptions…

http://localhost:8080/v3/api-docs/

it will appear like this.

you can edit the path for the url by adding this to application.properties

springdoc.api-docs.path=/api