[Network] HTTP Method(GET, POST, PUT, PATCH, DELETE)

URI 설계의 중요한 것은 리소스 식별

API URI(Uniform Resource Identifier)

• 리소스의 의미
  • 회원을 등록하고 수정하고 조회하는 것은 리소스가 아니다.
  • 예를들어 자원을 캐라 -> 자원이 리소스이다.
  • 회원이라는 개념 자체가 바로 리소스인 것이다.
• 회원이라는 리소스만 식별하면 된다. -> 회원 리소스를 URI에 매핑하면 된다.

좋지 못한 URI설계 - 회원 목록 조회 /read-member-list - 회원 조회 /read-member-by-id - 회원 등록 /create-member - 회원 수정 /update-member - 회원 삭제 /delete-member

좋은 URI 설계 - 회원 목록 조회 /members - 회원 조회 /members/{id} - 회원 등록 /members/{id} - 회원 수정 /members/{id} - 회원 삭제 /members/{id}

Post. 계층 구조상 상위 컬렉션으로 보고 복수 단어 사용을 권장한다.

 

리소스와 행위를 분리

URI는 리소스만 식별하고 리소스와 해당 리소스를 대상으로 하는 행위를 분리하는 것이 옳다

- 리소스: 회원

- 행위: 조회, 등록, 삭제, 변경

위의 좋은 URI 설계를 보면 구분하는 방법이 의아할 수 있다.

이를 구분 짓는 것은 HTTP 메서드이다. 

 

HTTP 메서드의 종류

GET: 리소스 조회한다.

POST: 요청 데이터 처리, 주로 등록에 사용한다.

PUT: 리소스를 대체, 해당 리소스가 없으면 생성한다.

PATCH: 리소스 부분 변경한다.

DELETE: 리소스 삭제한다.

 

기타 메서드

HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환한다.

OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)한다.

CONNECT: 대상 자원으로 식별되는 서버에 대한 터널을 설정한다.

RACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행한다.

GET

리소스 조회한다.

 

 

서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달한다.

메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않는다.

 

GET 동작 과정

1. 메시지 전달

2. 서버 도착

3. 응답 데이터

POST

요청 데이터를 처리한다.

메시지 바디를 통해 서버로 여청 데이터를 전달한다.

서버는 요청 데이터를 처리하고 메시지 바디를 통해 들어온 테이터를 처리하는 모든 기능을 수행한다.

주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용된다.

 

POST 동작 과정

1. 메시지 전달

2. 신규 리소스 생성

3. 응답 데이터

POST에서 요청 데이터를 처리한다는 뜻은 

공식 스펙: POST 메서드는 대상 리소스가 리소스의 고유 한 의미 체계에 따라 요청에 포함 된 표현을 처리하도록 요청합니다.

이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함 -> 정해진 것이 없음

 

POST 총정리

1. 새 리소스 생성(등록)

 - 서버가 아직 식별하지 않은 새 리소스를 생성한다.

2. 요청 데이터를 처리

 - 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야하는 경우.

  예를들어, 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우

 - POST의 결과로 새로운 리소스가 생성되지 않을 수도 있다.

  예를들어, POST /orders/{orderId}/start-delivery (컨트롤 URI)

 3. 다른 메서드로 처리하기 애매한 경우

  예를들어, JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우

  애매한 것들은 POST로 처리하자. 

 

PUT

리소스를 대체

  - 리소스가 있으면 대체

  - 리소스가 없으면 생성

  - 리소스를 덮어버린다.

클라이언트가 리소스를 식별

  - 클라이언트가 리소스 위치를 알고 URI 지정한다.

  - 이 점이 POST와 다르다.

 

PUT 동작 과정

리소스가 있는경우 1

리소스가 있는 경우 2

 

리소스가 없는 경우 1

리소스가 없는 경우 2

리소스를 완전히 대체한다 1

리소스를 완전히 대체한다 2

PATCH

리소스를 부분 변경한다.

PATCH 동작 과정

리소스 부분 변경1

리소스 부분 변경2

 

DELETE

리소스를 제거한다.

DELETE 동작 과정

리소스 제거 1

리소스 제거 2

 

HTTP 메서드 속성

안전(Safe Methods)

멱등(Idempotent Methods)

캐시가능(Cacheable Methods)

안전 - 호출해도 리소스를 변경하지 않는다.

멱등(Idempotent)

f(f(x)) = f(x)

한 번 호출하든 두 번 호출하든 n번 호출하든 결과가 같다.

멱등 메서드

• GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
• PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
• DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
• POST: 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.

멱등의 활용으로 자동 복구 메커니즘을 가질 수 있다.

Q: 재요청 중간에 다른 곳에서 리소스를 변경해버리는 경우는??

Ex)

사용자1: GET -> username:A, age:20

사용자2: PUT -> username:A, age:30

사용자1: GET -> username:A, age:30 -> 사용자2의 영향으로 바뀐 데이터 조회

A: 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지는 않는다.

 

캐시가능(Cacheable)

응답 결과 리소스를 캐시해서 사용해도 되는가?

GET, HEAD, POST, PATCH 캐시가능

실제로는 GET, HEAD 정도만 캐시로 사용

- POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지않다.

 

 

 

Reference.

HTTP - 위키백과, 우리 모두의 백과사전

HTTP 요청 메서드 - HTTP | MDN

모든 개발자를 위한 HTTP 웹 기본 지식 - 인프런 | 강의