메서드 | 내용 | 응답 메세지의 본문 |
---|---|---|
GET | 지정된 URI에서 Resource의 Representation을 검색 | 요청된 Resource의 세부 정보 |
POST | 지정된 URI에 새로운 Resouce를 생성 Resource를 생성하지 않는 작업을 수행할 수도 있음 | 새 Resource의 새부 정보를 제공 |
PUT | 지정된 URI에 Resource를 생성하거나 대체 | 만들 또는 업데이트할 Resource를 지정 |
PATCH | 지정된 URI에서 Resource의 부분 업데이트 수행 | Resource에 적용할 변경 내용을 지정 |
DELETE | 지정된 URI의 Resource를 제거 |
Resource가 컬렉션인지, 개별 항목인지에 따라 달라짐
전자 상거래 예시를 통한 RESTful 구현의 일반 규칙 요약
Resource | POST | GET | PUT | DELETE |
---|---|---|---|---|
/customers | 새 고객 생성 | 모든 고객 검색 | 고객 대량 업데이트 | 모든 고객 제거 |
/customers/1 | Error | 고객 1에 대한 세부 정보 검색 | 고객 1이 있는 경우 고객 1의 세부 정보 업데이트 | 고객 1제거 |
/customers/1/orders | 고객 1에 대한 새 주문 생성 | 고객 1에 대한 모든 주문 검색 | 고객 1의 주문 대량 업데이트 | 고객 1의 모든 주문 제거 |
멱등 법칙 / 멱등성이란?
PUT 요청은 idempotent여야 함
POST나 PATCH 요청은 반드시 idempotent가 된다는 보장을 할 수 없음
Reference:
마이크로 소프트 RESTful 웹 API 디자인 모범 사례