OpenAPI Contract

Swagger API 계약 검증

DocumentBuilder, SwaggerModule, Api 데코레이터를 연결하면 실제 라우트와 요청/응답 스키마를 문서로 확인할 수 있습니다.

문서 설정

DocumentBuilder

title, description, version, auth scheme을 정의해 OpenAPI 문서의 기본 정보를 만듭니다.

문서 노출

SwaggerModule.setup

생성된 문서를 특정 경로에 연결해 브라우저에서 API 목록과 스키마를 확인합니다.

컨트롤러 설명

ApiTags / ApiOperation

라우트를 기능별 태그로 묶고 작업 설명을 붙여 클라이언트가 의도를 파악하게 합니다.

DTO 스키마

ApiProperty

요청 필드의 타입, 예시, 필수 여부를 문서에 드러내 검증 규칙과 계약을 맞춥니다.