Design review
REST API 설계 점검표
REST API는 URI, 메서드, 상태 코드, DTO 검증이 같은 리소스 규칙을 따를 때 유지보수하기 쉽다.
일관성 검사
통과 기준
| URI가 명사형 리소스다. |
| 행위는 HTTP 메서드로 표현한다. |
| 성공과 실패 상태 코드가 구분된다. |
| 요청 DTO와 응답 모델이 문서와 맞다. |
수정 필요
| URI에 동사가 반복된다. |
| 모든 응답이 200으로만 내려간다. |
| 검증 오류와 서버 오류를 같은 형식으로 숨긴다. |
| 목록, 상세, 생성 응답 모양이 제각각이다. |