개발자 API 협업 툴 - Swagger

요즘은 프론트엔드와 백엔드가 따로 독립적으로 분리가 된 상태에서 개발을 하는 경우가 많다.

따로 개발을 하고, API 엔드 포인트를 통해서 프론트 엔드와 서버가 통신을 하는 것이다.

위와 같은 개발 방식을 REST API 라고도 흔히 부른다.

HTTP 요청을 통해서 리소스 등을 요청하고 받는 것이다.

이러한 개발 방식을 사용하기 위해선, 백엔드 개발자는 API 명세서를 작성해야 한다.

API 명세서를 작성한 뒤, 이를 프론트엔드 개발자에게 보내주어야 API 통신 규격을 정하고, 통신할 수 있다.

이를 직접 다 작성해도 무방하지만, 이를 자동화해주는 편리한 개발 툴이 있다.

그게 이제 설명할 "Swagger" 이다.

 

Swagger란?

• Swagger는 개발한 Rest API를 문서화 한다.
• 문서화된 내용을 통해 버전 관리
• API 호출을 통한 테스트가 가능하다.

Swagger 라이브러리의 종류 2가지

• Spring-Fox
  • 오래전에 나온 라이브러리
  • 2020년 이후로 업데이트가 없다.
• Spring-Doc
  • 2019년에 나온 라이브러리
  • 꾸준하게 업데이트

이제는 Spring-Doc을 사용해야 한다.

( Spring Boot 3을 이용할 경우, SpringFox는 아예 동작하지 않는다고 한다 )

---

스프링 부트에 Swagger를 적용하는 것은 아래의 글을 읽어보자.

 

2024.04.07 - [Project/협업 툴] - Spring Boot에 Swagger 적용하기(Spring-Doc)

Spring Boot에 Swagger 적용하기(Spring-Doc)