DTO 기준
필드 설명, 예시 값, required 여부를 문서에서 명확히 드러냅니다.
Swagger를 이용한 API 문서화 인터페이스 계약
Swagger 문서는 Nest decorator, DTO, 인증 요구조건이 실제 handler와 같은 상태인지 드러내는 계약 표면입니다.
Decorator 기준
controller decorator가 method, path, response, auth 조건을 문서에 연결합니다.
Consumer 기준
외부 사용자가 의존할 입출력 경계를 구현 세부보다 먼저 고정합니다.
성공 응답과 에러 응답을 모두 ApiResponse 계열로 남깁니다.
ApiProperty와 class-validator가 다른 말을 하지 않는지 확인합니다.
토큰 만료나 rate limit처럼 클라이언트 대응이 필요한 실패를 표시합니다.