Spring Boot 3.x에 Swagger 적용 : springdoc-openapi 라이브러리 사용

springdoc-openapi 라이브러리란 ?

• 스프링 부트 프로젝트를 사용하여 API 문서 생성을 자동화 해주는 도구
• springdoc-openapi는 스프링 구성, 클래스 구조 및 다양한 주석을 기반으로 API 의미를 추론하기 위해 런타임에서 애플리케이션을 확인하여 작동하는 방식
• JSON / YAML / HTML 형식 API로 문서 생성

 

Spring Boot 3.x에 Swagger 적용 방법

* 개발 환경

Spring boot 버전 : 3.0.6

Maven 사용

Ecplipse 2023-3

Java 17

 

 

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

 

먼저 spring-boot와 swagger-ui 간의 통합을 위해 라이브러리를 pom.xml에 추가해준다.

 

의존성만 추가하면 별다른 추가 구성 없이 Swagger UI 페이지를 사용할 수 있다.

 

http://${server}:${port}/swagger-ui/index.html

 

 

실제로 접속해보면 위와 같은 화면이 나온다.