Swagger는 코드 옆 메타데이터를 API 계약으로 모은다
수동 문서는 코드와 어긋나기 쉽다. Nest Swagger는 DTO와 컨트롤러 데코레이터를 OpenAPI 명세와 Swagger UI로 연결한다.
코드에 붙이는 정보
DocumentBuilder제목, 버전, 태그, 인증 스키마를 고정한다.
DTO Decorator필드 설명, 예시, 제약 조건을 스키마로 드러낸다.
Controller경로, HTTP 메서드, 응답 상태와 태그를 모은다.
문서에서 보이는 결과
Swagger UI엔드포인트와 요청 예시를 사람이 확인한다.
OpenAPI Spec프론트엔드, 테스트, SDK 생성 도구가 같은 계약을 읽는다.
Try it out문서 화면에서 요청을 보내 실제 계약을 검증한다.
검수 기준: 입력 구조, 응답 구조, 인증 방식이 실제 API 코드와 같은지 확인한다.