OpenAPI Sync

Swagger API 계약 동기화

DocumentBuilder, SwaggerModule, @ApiProperty, @ApiResponse를 실제 controller 동작과 맞춰야 클라이언트가 문서를 계약으로 삼습니다.

Document

문서 생성

DocumentBuilder로 title, version, server, tag, auth scheme를 API 단위로 선언합니다.

Model

DTO 노출

@ApiProperty와 enum, example을 DTO에 붙여 요청과 응답 스키마를 구체화합니다.

Route

응답 설명

@ApiOperation, @ApiResponse, @ApiParam으로 status code와 오류 케이스를 명시합니다.

Auth

인증 연동

Bearer auth나 cookie auth를 등록하고 보호 라우트에는 @ApiBearerAuth를 붙입니다.