REST 리소스를 명사와 상태 코드로 설계하기

RESTful API 설계는 URL 모양을 예쁘게 만드는 일이 아니라, 리소스와 HTTP method, 상태 코드가 같은 의미를 갖도록 맞추는 일이다.

01

리소스 모델링

동사형 작업보다 클라이언트가 다룰 대상을 먼저 정의한다.

02

메서드 매핑

조회, 생성, 수정, 삭제의 의미를 HTTP method에 맞춘다.

03

오류 설계

validation, not found, conflict, forbidden을 다른 코드와 본문으로 표현한다.

04

확장

pagination, filtering, versioning을 초기에 계약에 포함한다.

5

명사 URL

endpoint가 action보다 resource 중심이다.

핵심REST 리소스를 명사와 상태 코드로 설계하기은 각 요소의 관계와 선택 조건을 함께 읽어야 한다.