Swagger란? Swagger 도입 방법(Java - Spring Boot 기반 작업 기준)

안녕하세요.

이번 포스팅은 Swagger라고 다뤄보고자 합니다.

주로 프론트엔드와 백엔드 개발자와 협업을 할때 API 문서를 주고 받는데 많이 사용하고 있습니다.

하지만, 백엔드 개발자 입장에서는 API 개발을 하고, 프론트엔드 개발자에게 API를 공유해야하는 상황이 올텐데 API 문서 작업을 최소화 하기 위해 도입된 것이 바로 Swagger 입니다.

따라서 Swagger의 대해서 알아보겠습니다.

 

 

1. Swagger

- 오픈 소스 라이브러리 중 하나이며, 백엔드를 위한 개발자를 위한 문서 

- API 명세서가 적혀 있고, 지금까지 개발 된 API를 확인 할 수 있습니다.

- 따라서 프론트엔드 개발자에게 API 개발된 내용을 공유할 때 유용하게 할 수 있는 툴입니다.

 

 

2. Swagger 도입하기

- Java 17, Spring Boot 3.x.x, gradle 기반 기준으로 Swagger를 도입하겠습니다.

- 이전 버전에 비해서 현재 Spring Boot 3.x.x 기준으로는 단순히 라이브러리 연동만 하고 property 작업만 하고 추가 작업 사항은 없습니다.

- spring boot 3.x.x. 이상의 버전에서는 라이브러리는 springfox 대신 springdoc로 대처합니다.

 

(1) Spring boot에서 build.gradle을 열고 아래와 같이 넣어줍니다.

// https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.3.0'

 

 

(2) property 파일에서 아래와 같이 설정

spring.mvc.pathmatch.matching-strategy: ANT_PATH_MATCHER

 

 

 

(3) localhost:{port}/swagger-ui/index.html 접속

 

 

 

이와 같이 확인할 수 있습니다.

 

이것으로 Swagger의 대한 포스팅을 마쳐보겠습니다.

감사합니다.