본문 바로가기
개발

Swagger 적용하기 - SpringBoot3 버전

by 공덕뉸나 2023. 7. 18.

이전 글에서는 swagger를 사용하기 위해 springfox를 사용했다.

하지만 spring boot 3 부터는 javax.*가 아닌 jakarta.*를 사용한다. 

그래서 javax.*를 사용하는 라이브러리들이 정상동작하지 않는 경우가 생겼고 springfox도 제대로 동작하지 않는다.

 

적용법은 기존 방식보다 굉장히 간단해졌다.

 

1. build.gradle

 

implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2")

 

2. application.yml

springdoc:
  api-docs:
    path: /api-docs
  swagger-ui:
    path: /swagger-ui.html
  packages-to-scan:

 

3. url 허용

"/api-docs/**", "/swagger-ui/**",  "/swagger-ui.html"

위 application.yml과 같이 설정했다면 url을 상황에 맞게 접근허용해주면된다.

 

버전은 계속 업데이트 되므로 사용할 때에는 현재 버전이 내가 사용하려는게 맞는지 잘 확인해야겠다.

spring boot3에 springfox를 적용하다 헤매고 있는 사람들한테 도움이 되었으면 좋겠다. 망망!