Swagger

Seoyeon·2025년 9월 1일
0

백엔드기초

목록 보기
11/17

Swagger란?

  • REST API를 문서화하고 테스트할 수 있게 해주는 오픈소스 프레임워크
  • 원래 이름은 Swagger였는데, 지금은 OpenAPI Specification(OAS) 라고 부르는 게 공식 명칭
  • Swagger는 그 OpenAPI를 편하게 쓰도록 도와주는 툴 모음 이름

왜 필요한가?

  • API는 “사람끼리의 약속”이라서, 정확한 스펙이 없으면 개발자마다 다르게 이해할 수 있음
  • 보통 문서를 따로 작성하면 코드랑 문서가 따로 놀아서 유지보수 힘듦
  • Swagger는 코드에 어노테이션만 달면 → 자동으로 API 문서 생성
  • 그 문서를 웹 UI로 제공해서, 개발자나 QA, 심지어 클라이언트 팀도 API 직접 눌러보면서 테스트할 수 있음

Swagger UI

  • 가장 많이 보는 화면 → http://localhost:8080/swagger-ui.html
  • API 목록이 쫙 나오고, 각 엔드포인트 눌러서 요청/응답 확인 가능
  • Postman 같은 별도 툴 안 쓰고 브라우저에서 바로 테스트 가능

Swagger의 장점

  • API 문서 자동 생성 → 따로 관리할 필요 없음
  • 문서와 코드가 항상 동기화
  • UI로 바로 테스트 가능
  • 팀 내/외부 협업 시 “API 스펙 공유”가 훨씬 편해짐

0개의 댓글