🔙뒤로가기

스웨거(Swagger)란?

Swagger는 API를 설계, 빌드, 문서화, 그리고 사용하기 위한 강력한 오픈소스 프레임워크이다. Swagger는 웹 서비스와 같은 RESTful API를 설계하고, 프로토타입을 만들고, 문서화하고, 테스트하도록 도와준다.

Swagger는 프로젝트의 API를 시각적으로 표현하고, API가 어떻게 동작하는지, 어떤 값들을 가지고 있는지, 어떤 제약 사항들이 있는지 등을 쉽게 이해할 수 있게 해준다. 이는 개발자가 API에 대한 심층적인 이해 없이도 API의 기능을 쉽게 파악하고 사용할 수 있게 한다.

Swagger의 두 가지 요소

1. Swagger Editor: 이는 웹 기반 에디터로, 사용자가 Swagger를 이용해 API를 정의하고, 그 정의에 따라 API를 디자인하고, 그리고 API에 대한 문서를 생성하고, API를 테스트하게 해주는 도구이다.
2. Swagger UI: 이는 사용자가 Swagger를 이용해 생성한 API 문서를 웹 페이지 형태로 보여주고, 브라우저에서 API를 직접 호출해보고 테스트할 수 있게 해주는 도구이다.

왜 Swagger가 필요한가?

1. 문서화
   • Swagger를 사용하면, API를 정의하고 구현하는 과정에서 자동적으로 문서가 생성됨.
   • API의 동작 방식, 요청 및 응답 형식 등에 대한 문서화를 쉽게 할 수 있음.
   • 이 문서는 실시간으로 업데이트되며, 클라이언트 개발자와 백엔드 개발자 사이의 협업을 용이하게 함.
2. API 디자인 및 테스트
   • Swagger Editor를 통해 API를 시각적으로 디자인하고, API의 동작을 테스트할 수 있음.
   • 이를 통해 API의 프로토타입을 빠르게 만들고 반복적으로 테스트하면서 API를 개선할 수 있음.
3. 생산성 향상
   • Swagger UI를 통해 개발자는 웹 브라우저에서 API를 직접 실행해볼 수 있음.
   • 개발자는 API의 기능을 빠르게 이해하고 개발 작업에 들어갈 수 있음.
   • 예상치 못한 동작이나 오류를 빠르게 발견하고 수정할 수 있음.
   • 이는 전반적인 개발 프로세스의 생산성을 향상시킴.
4. 표준화
   • Swagger는 OpenAPI 명세를 따름.
   • API의 설계와 문서화에 표준을 제공함.
   • 이 표준화는 API의 구조와 문서화 방식에 일관성을 부여하고, 다른 시스템과의 호환성을 향상시킴.
5. 호환성
   • Swagger에서 생성된 API 문서는 JSON이나 YAML 등의 표준 데이터 포맷을 사용함.
   • 따라서 다양한 플랫폼과 언어에서 쉽게 적용할 수 있음.
   • 이는 API를 다른 시스템과 통합하는 데 도움을 줌.
6. 커뮤니티와 지원
   • Swagger는 광범위한 사용자 커뮤니티를 가지고 있음.
   • 다양한 추가 도구와 플러그인이 존재하며, 계속 개발 중.
   • 이를 통해 API 개발에 있어 다양한 지원 가능.