[Spring Boot] Swagger 3.0 적용하기

Swagger의 3.0 버전을 새로운 토이 프로젝트에 적용해 보려 한다. 기존에는 적용해보지 않았지만 API 문서작업이 필요함을 느끼고 작업을 진행해 보려 한다.

문서작업이 항상 먼저지만 그와는 별개로 Swagger는 클라이언트에서 작업하기에 편한 문서가 안닐까 생각된다. 물론 서버에서 API를 실행해 보기 좋은 방법이기도 하다.

---

Swagger 3.0 종속성 설치

첫 시작부터 쉽지 않았던것 같다. 종속성을 설치해도 페이지가 접속되지 않았기 때문이다. 그렇게 한참을 뒤져보다가 하나의 해답을 찾아냈다.

 

https://stackoverflow.com/questions/74614369/how-to-run-swagger-3-on-spring-boot-3

How to run Swagger 3 on Spring Boot 3

 

이 해답에서 나온 방법은 아래의 종속성을 사용해야 한다는 것이다.

// swagger
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'

 

이후 사용 방법은 공식 문서를 참고하면 된다.

공식문서: https://swagger.io/docs/specification/about/

---

간단한 설치 방법인데도 한참을 돌아간 것 같다. 이렇게 알아보는 재미가 있긴 하지만 쉽게 갈 수 있는 부분은 쉽게 해결해야 하기에 항상 기록을 남긴다.