Swagger 란?

시간 소요가 많고 관리하기 번거롭던 API 명세서 작성 작업을 Swagger를 통해 간단하게 해결

*자세한 설명 생략

 

 

▷ Swagger 란?

*OAS : Open API Specification

 

• API의 명세(Spec)를 문서화하여 관리하기 위한 프로젝트
• API의 명세(Spec) 수정 시 문서 자동 갱신
• Spring / Spring Boot Project에서 사용 가능
• 대표적인 라이브러리 : Springdoc, Springfox
  *차이점이 있고 Springdoc 선호

 

 

▷ Swagger 특징

 

• Annotation을 통해 API를 빠르게 명세
• Swagger-UI를 통해 API를 시각화한 화면 제공
• Swagger-UI를 통해 API 테스트 진행 가능

 

 

▷ Swagger 사용 이유

 

• 엑셀로 관리하던 인터페이스 설계서를 Swagger를 통해 간단하게 생성, 관리
• Front End 개발자와 Swagger를 통해 소통 가능
• 프로젝트 산출물로 필요한 문서를 간단하게 생성 가능(별도의 파일로 저장 가능)

 

 

▷ 참고

API Documentation & Design Tools for Teams | Swagger

Swagger 연동 및 설정 방법