REST API 설계의 리소스 중심 사고

리소스 모델링

URL 동사보다 주문, 사용자, 게시글 같은 리소스 명사를 먼저 확정한다.

GET, POST, PATCH, DELETE의 의미와 부작용을 맞춘다.

성공 본문, 오류 코드, validation 오류 구조를 고정한다.

필드 추가와 호환성 규칙을 정해 클라이언트 파손을 줄인다.

/users

컬렉션 목록 조회와 새 사용자 생성의 대상

필터는 query string

/users/{id}

단일 리소스 특정 사용자의 조회, 수정, 삭제

없는 id는 404

201

생성 성공 새 리소스와 Location header를 함께 줄 수 있음

POST 성공에 적합

409

상태 충돌 중복 이메일, 버전 충돌처럼 요청은 맞지만 현재 상태와 충돌

400과 구분

명사 URL 엔드포인트가 action보다 resource 중심으로 읽힌다.

상태 코드 오류를 모두 200이나 500으로 뭉개지 않는다.

페이지네이션 목록에는 limit, cursor, total 정책이 있다.

호환성 필드 제거와 의미 변경은 버전 전략을 거친다.