Decorators

데코레이터는 코드의 API 의도를 OpenAPI 스키마로 모은다

DTO와 컨트롤러 옆에 붙인 설명은 SwaggerModule을 거쳐 요청/응답 모델, 라우트 목록, 테스트 가능한 문서로 정리된다.

01 DTO @ApiProperty 필드 타입, 예시, 설명을 모델 스키마로 남긴다.
02 Controller @ApiOperation 엔드포인트의 목적과 태그를 문서 목록에 붙인다.
03 Response @ApiResponse 성공, 실패, 보안 조건을 호출자가 예상하게 만든다.
04 Swagger UI 문서와 테스트 읽는 자리에서 요청을 보내 계약을 확인한다.
코드 위치 문서 결과 검수 질문
DTO 필드 요청/응답 schema 필수값과 예시가 실제 validation과 맞는가
Controller 메서드 route, summary, tag HTTP 메서드와 상태 코드가 맞는가
인증 설정 Bearer 입력과 보호 API 표시 토큰이 필요한 라우트가 문서에 드러나는가

기준: 문서는 별도 글이 아니라 코드 옆 API 계약의 렌더링이다.