Resource contract

RESTful API 표현 방식

URI는 대상을, HTTP 메서드는 작업을, 상태 코드는 결과를 맡는다. 세 역할을 섞지 않는 것이 핵심이다.

URI + Method + Status
요청의미응답 기준
GET /users사용자 목록 조회200과 배열 응답
POST /users사용자 생성201과 생성된 리소스
PATCH /users/:id일부 필드 수정200 또는 204
DELETE /users/:id사용자 삭제204 또는 삭제 결과

명사형 URI

/createUser보다 /users

일관된 복수형

컬렉션과 단일 리소스 규칙을 유지한다.

오류 응답

검증 실패와 없는 리소스를 구분한다.