데코레이터
컨트롤러와 DTO에 설명, 예시, 응답 타입을 붙인다.
OpenAPI
Swagger API 계약
라우트, 요청 바디, 응답 타입, 인증 요구를 문서화하면 프론트엔드와 백엔드의 기대가 맞아진다.
문서 생성 흐름
API 계약스키마
DTO 구조가 OpenAPI schema로 변환되어 요청과 응답 모양을 설명한다.
UI
Swagger UI에서 요청 파라미터와 응답 예시를 확인하고 실제 호출 결과를 계약과 대조한다.
협업
계약 문서가 있으면 클라이언트 구현과 서버 변경의 차이를 줄일 수 있다.
decoratorschemadocsclient
API 문서는 나중에 쓰는 설명서가 아니라, 서로 다른 팀이 같은 계약을 보고 개발하게 하는 기준이다.