본문 바로가기
IT 공부/자바와 웹 애플리케이션

[swagger] - 스프링부트 3.x 이상 사용 시 swagger 설정법

by exdus3156 2024. 1. 22.

강의와 책에서 Swagger-UI를 사용할 때 아래와 같은 의존성을 다운받으라고 안내한다.

implementation 'io.springfox:springfox-boot-starter:3.0.0'
implementation 'io.springfox:springfox-swagger-ui:3.0.0'

그러나 스프링부트 3.x 버전 이상부터는 더 이상 springfox 계열의 swagger는 업데이트되지 않는다. 따라서 다른 의존성을 사용해야 한다. 

implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.3.0'

 

 

OpenAPI 3 Library for spring-boot

Library for OpenAPI 3 with spring boot projects. Is based on swagger-ui, to display the OpenAPI description.Generates automatically the OpenAPI file.

springdoc.org

springdoc이 제공하는 swagger를 사용하는 것이 좋다. springfox와는 달리, springdoc은 특별히 @Configuration으로 설정해야 할 클래스도 요구하지 않아 편리하다. 정말로 딱히 설정해야 할 무언가가 없다. 의존성을 추가하는 것으로 끝이다.

이때 springfox-swagger의 다양한 어노테이션과 설정의 상세 사항이 달라지게 되는 문제가 발생한다. 이는 아래의 공식 홈페이지를 가서 어떻게 전환하면 되는지 파악하면 된다.

@출처