Skip to content

Test Spring Boot project to explain how to add Spring Doc OpenAPI UI documentation

Notifications You must be signed in to change notification settings

victormartingil/springdoc-openapi-ui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Add SpringDoc OpenAPI UI to your Spring Boot Project

Tested with Java 17 and SpringBoot 2.7.6

STEP 1

Add the dependency SpringDoc OpenAPI UI:

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

https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-ui

STEP 2

Add the following property in application.properties file
This is optional but could avoid few future problems

spring.mvc.pathmatch.matching-strategy=ant-path-matcher

STEP 3

Check Swagger UI website Run your application and access the following url:

host:port/swagger-ui/index.html
http://localhost:8080/swagger-ui/index.html

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

About

Test Spring Boot project to explain how to add Spring Doc OpenAPI UI documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages