Swagger란?

---

• 스웨거는 개발자가 REST API 서비스를 설계, 빌드, 문서화하는 도구이다
• API가 수정되더라도 문서가 자동으로 갱신된다
• API 명세서를 자동화 할 수 있다

Swagger-ui

따로 구현할 필요 없이 API를 시각화하고 resource를 한눈에 보는 것이 가능하다

SpringBoot에 적용하기

---

Swagger를 스프링 부트 프로젝트에 적용하기 위해 검색해봤다. 보통 springfox를 사용한 글이 많이 나왔는데 springfox는 2020년 이후로 업데이트가 중지되어서 Springboot 3.x.x과는 충돌이 일어나는 일이 많다고 한다.
따라서 springfox가 아닌 springdoc-openapi-ui를 사용했다.
공식 문서를 참고해서 프로젝트에 적용할 수 있었다.

Dependency 추가

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

• pom.xml 파일에 의존성을 추가한다.

의존성만 추가하면 매우 간단하게 swagger를 적용시킬 수 있다. 원하는 포맷에 따라 JSON 형태의 값을 반환받거나 api-docs를 파일로 저장하거나 swagger-ui를 이용해 시각화 된 api를 확인할 수 있다.
Json format : http://server:port/context-path/v3/api-docs
Swagger-ui : http://server:port/swagger-ui/index.html#/