How use OpenAPI and Swagger UI in Spring Boot

Swagger UI

An open API (often referred to as a public API) is a publicly available application programming interface that provides developers with programmatic access to a proprietary software application or web service.

Step 01

Create Spring Boot web project from Spring Initializr and import it to the your favorite IDE.

Step 02

Add OpenAPI dependency Maven Repository: org.springdoc » springdoc-openapi-ui (mvnrepository.com)

<!-- https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-ui -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.6.4</version>
</dependency>

Step 03

Update application.properties file as your wish

# swagger-ui custom path

springdoc.swagger-ui.path=/swagger-ui-example.html

Step 04

Project Structure

SimpleApiDocumentationApplication.java

Dao.java

ProductDao.java

Product.java

ProductsResource.java

ProductService.java

Story 05

Now can access http://localhost:8080/swagger-ui-example.html via swagger UI.

Story 06

deshapriya199/simpleAPIDocumentation (github.com)