HTTP 메서드 종류
GET
- 리소스 조회
- query를 통해 서버에 데이터 전달
- 메시지 body를 통한 데이터 전달 지양
POST
- 메시지 바디를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리하는 모든 기능을 수행
- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
POST는 데이터 등록만 처리하는 메서드가 아니며, 아래 작업들도 포함한다.
1. 새 리소스 등록
2. 요청 데이터 처리
- POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
Ex. POST /orders/{orderId}/start-delivery(컨트롤 URI)
3. 다른 메서드로 처리하기 애매한 경우
PUT
- 리소스를 대체
- 리소스가 있으면 대체
- 주의) 리소스를 완전히 대체한다. => 부분 변경을 원한다면 PATCH 사용
- 리소스가 없으면 생성
- 클라이언트가 리소스를 식별
- 클라이언트가 리소스 위치를 알고 URI 지정 (POST와 차이점)
PATCH
DELETE
HTTP 메서드 속성
안전 (Safe)
멱등 (Idempotent)
- 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.
- 멱등 메서드
- GET, PUT, DELETE : 같은 결과
- POST : 멱등이 아니다. 두 번 호출하면 같은 프로세스가 중복해서 발생할 수 있다.
멱등의 활용
- 자동 복구 메커니즘
- 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가? 판단 근거
캐시가능 (Cacheable)
- 응답 결과 리소스를 캐시해서 사용해도 되는가?
- GET, HEAD 정도만 캐시로 사용
HTTP API 설계
HTTP API - 컬렉션
컬렉션
서버가 관리하는 리소스 디렉토리 (Ex. /members)
- POST 기반 등록
- 서버가 리소스 URI 결정
- 서버가 새로 등록된 리소스 URI를 생성해준다.
Ex. HTTP/1.1 201 Created
Location: /members/100
HTTP API - 스토어
스토어
클라이언트가 관리하는 리소스 저장소 (Ex. files)
- PUT 기반 등록
- 클라이언트가 리소스 URI 결정
- Ex. 파일 등록/files/{filename} -> PUT
- PUT /files/star.jpg