decorators

Swagger 문서 생성

@ApiProperty, @ApiOperation, @ApiResponse 같은 데코레이터는 코드 옆에 API 계약을 붙이고, SwaggerModule은 이를 OpenAPI 문서로 모은다.

코드에 붙이는 정보

1

DTO 필드 설명

@ApiProperty()

name, email, age 같은 필드에 설명과 예시, 범위를 기록한다.

2

엔드포인트 의미

@ApiOperation()

각 메서드가 무엇을 하는지 summary와 description으로 표현한다.

3

응답과 인증 조건

@ApiResponse()

성공, 실패, 보안 스키마를 함께 적어 호출자가 기대값을 안다.

문서에서 보이는 결과

controller DTO OpenAPI Swagger UI
schema

요청/응답 모양

DTO 필드와 타입이 문서의 모델 스키마로 정리된다.

route

API 목록

users 태그 아래 GET, POST, PATCH, DELETE 작업이 묶인다.

test

Try it out

문서를 읽는 자리에서 요청을 보내며 계약을 확인할 수 있다.