Design review

REST API는 네 가지 계약이 같은 리소스 규칙을 따라야 한다

URI, 메서드, 상태 코드, DTO 검증이 서로 다른 말을 하면 유지보수가 어려워진다. 통과 기준과 수정 신호를 나누어 점검한다.

통과 기준

  • URI가 명사형 리소스다.
  • 행위는 HTTP 메서드로 표현한다.
  • 성공과 실패 상태 코드가 구분된다.
  • 요청 DTO와 응답 모델이 문서와 맞다.

수정 필요

  • URI에 동사가 반복된다.
  • 모든 응답이 200으로만 내려간다.
  • 검증 오류와 서버 오류를 같은 형식으로 숨긴다.
  • 목록, 상세, 생성 응답 모양이 제각각이다.