[ HTTP ] HTTP API 설계 시 사용하는 메서드 종류

HTTP API 설계 요구사항을 보고 회원 정보 관리 API를 만들어야 하는 상황에 놓였다면?

 

(예시) 회원 정보 관리 API 요구사항

- 회원 목록 조회

- 회원 조회

- 회원 등록

- 회원 수정

- 회원 삭제

 

(예시) API URI 설계 단계

URI에서 가장 중요한 것은 리소스 식별 이다. -> '회원' 이라는 리소스만 식별 (members)

그리고 리소스와 해당 리소스를 대상으로 하는 행위(메서드)를 분리

 

- 회원 목록 조회 : /members

- 회원 조회 : /members/{id}

- 회원 등록  : /members/{id}

- 회원 수정  : /members/{id}

- 회원 삭제  : /members/{id}

=> 구분은 어떻게? HTTP 메서드를 통해서

 

HTTP 메서드

- GET : 리소스 조회

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

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

- PATCH : 리소스 부분 변경

- DELETE : 리소스 삭제

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

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

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

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

 

GET

리소스 조회

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

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

 

POST

요청 데이터 처리

메시지 바디를 통해 서버로 요청 데이터 전달

서버는 요청 데이터를 처리

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

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

 

현재 사용되는 POST 주요 기능들을 살펴보면?

- HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공

- 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지를 게시

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

- 기존 자원에 데이터 추가

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

 

그래서 POST를 언제 쓰는가?

1. 새 리소스 생성 및 등록

2. 요청 데이터 처리

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

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

          (이 때 control URI 사용할 수도 있음)

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

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

 

PUT

리소스를 대체 (리소스가 있으면 대체, 리소스가 없으면 생성)

클라이언트가 리소스의 위치를 알고 URI로 지정한다. 이것이 POST와의 큰 차이.

주의할 점: 리소스를 완전히 대체한다. 기존의 리소스를 완전히 삭제하고 다시 집어 넣는 개념이다. 그래서 리소스 부분 수정이 어렵다.

 

PATCH

리소스의 부분 변경

 

DELETE

리소스의 제거

 

 

HTTP 메서드의 속성

 

1. 안전

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

 

2. 멱등성 (Idempotent)

한 번 호출하든 두 번 호출하든 몇 번을 주구장창 호출하든 결과가 똑같다.

하지만 멱등은 외부 요인으로 중간에 리소스가 변경되는 것까지는 고려하지 않는다. (사용자1이 get 요청을 하고 있는 도중 사용자2가 put으로 리소스 변경해버리는 상황과 같이... 이런 것은 서버에서 해결책을 찾던가 해야함)

 

-GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.

-PUT: 결과를 대체한다. 따라서 같은 요청을 여러 번 해도 최종 결과는 같다.

-DELETE: 결과를 삭제한다. 같은 요청을 여러 번 해도 삭제된 결과는 똑같다.

-POST: 멱등이 아니다. 두번 호출하면 같은 결제가 중복해서 발생할 수 있다.

 

멱등성을 어떻게 활용하는가?

자동 복구 메커니즘 -> 만약 서버가 정상응답을 못 주었을 때, 클라이언트가 이전과 같은 요청을 다시 해도 되는가? 에 대한 판단 기준이 됨.

 

3. 캐시가능 Cacheable

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

GET, HEAD, POST, PATCH 캐시 가능

실제로는 GET, HEAD 정도만 캐시로 사용. POST, PATCH 는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않음.