OpenAPI Sync

Swagger API 문서 계약

SwaggerModule과 데코레이터를 사용하면 엔드포인트, 요청 DTO, 응답 예시를 코드와 함께 유지할 수 있습니다.

설정

SwaggerModule 등록

DocumentBuilder로 제목, 버전, 인증 방식을 정의하고 문서 엔드포인트를 엽니다.

엔드포인트

컨트롤러 설명

@ApiTags, @ApiOperation으로 기능 그룹과 동작 의도를 문서에 남깁니다.

데이터 형태

DTO 속성

@ApiProperty로 필드 설명, 예시, 필수 여부를 표시해 프론트엔드가 계약을 읽게 합니다.

검증

Swagger UI 테스트

문서 화면에서 요청을 실행해 실제 validation과 응답 상태가 설명과 맞는지 확인합니다.