HTTP 메서드

뭐라고? GET에 Body가 있다고?

 

28기 SOPT를 뒤흔들었던 사건이 있다 .. 오무렌 .. 비움 .. 캐치미 팀에서 동시다발적으로 일어난 그 사건을 우리는 'GET에 Request Body가 있다면?'이라고 부르기로 했다 .. 결론은 (따지고 보면 가능하지만) 안된다. 안돼요. 아 되었는데? 아니 안돼요. 그냥 안돼요.

 

..

서론이 길었음 ;; 

 

HTTP API

예를 들어서 회원정보관리 API를 만든다고 생각해보자.

그러면 아래와 같은 목록을 만들어야겠지?!

• 회원 목록 조회
• 회원 조회
• 회원 등록
• 회원 수정
• 회원 삭제

그리고 아래와 같이 API URI를 설계할 수 있을 것임..

회원 목록 조회	/read-member-list
회원 조회	/read-member-by-id
회원 등록	/create-member
회원 수정	/update-member
회원 삭제	/delete-member

 

그리고 나서 우와. 나 진짜 잘짰다. 혹시 나 천재개발자?! 라고 생각할 수 있는데 ..

정신차려 이 각박한 세상 속에서 

 

왜? 무엇이 문제일까?

URI를 짜는 이유는 식별자. 를 구분하기 위해서 !!

그리고 식별해야 하는 것은 리소스 식별이다. 

 

다시 고민해보자.

URI는 Uniform Resource Identifier, 즉 리소스를 식별하는 통합된 방법이다.

 

🟡 리소스의 의미는 무엇일까?

위에서 적은 것은 회원을 등록/수정/조회하는 것인데, 회원 등록/수정/조회는 리소스가 아니다.

예를 들어서 미네랄을 캐라. 라고 했을 때 > 미네랄이 리소스이다.

회원을 등록/수정/조회에서는 회원이라는 개념 자체가 리소스이다.

 

🟡 리소스를 어떻게 식별하는 것이 좋을까?

회원을 등록/수정/조회는 모두 배제하고

회원이라는 리소스만 식별하면 된다. > 회원 리소스를 URI에 매핑 

 

API URI 설게

• 회원 목록 조회
• 회원 조회
• 회원 등록
• 회원 수정
• 회원 삭제

회원이 리소스가 된다.

 

그러므로 아래와 같이 API를 설계할 수 있다. (이 때, URI 계층 구조를 활용해야 한다.)

회원 목록 조회	/members
회원 조회	/members/{id}
회원 등록	/members/{id}
회원 수정	/members/{id}
회원 삭제	/members/{id}

 

이렇게 되면 한가지 의문이 들게 될 것인데 .. 식별자가 리소스이기 때문에 그에 맞게 API를 설계하게 되면 조회/동록/수정/삭제 등은 어떻게 구분해야 하는 것일까? 하는 것이다.

 

🟢 리소스와 행위를 분리한다.

중요한 것은 리소스를 식별하는 것이므로 URI는 리소스를 식별한다.

그리고 리소스와 해당 리소스를 대상으로 하는 행위는 분리한다.

• 리소스 : 회원 (= members)
• 행위 : 조회/등록/삭제/변경

*리소스는 명사, 행위는 동사

 

HTTP 메서드 

위에서 말하는 동사를 곧 메서드로 구분한다. 

 

HTTP 메서드 종류

주요 메서드

• GET : 리소스 조회
• POST : 요청 데이터 처리, 주로 등록에 사용
• PUT : 리소스 대체, 해당 리소스가 없다면 생성 
• PATCH : 리소스 부분 변경
• DELETE : 리소스 삭제

기타 메서드

• HEAD : GET과 동일하지만 메시지 (Body) 부분을 제외하고 상태 줄과 헤더만 변환 
• OPTIONS : 대상 리소스에 대한 통신 가능 옵션을 설명 
• CONNECT
• TRACE 

 

GET

리소스 조회

• 서버에 전달하고 싶은 데이터는 쿼리(쿼리 파라미터, 쿼리 스트링)를 통해서 전달한다.
• 메시지 바디를 이용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많기 때문에 권장하지 않는다. 

 

동작 순서

1. 클라에서 서버에게 메시지를 전달한다.
2. 서버에 메시지가 도착하면,
3. 리소스 + 메서드를 바탕으로 해당하는 응답 데이터를 전달한다.

 

POST

요청 데이터 처리 

🔴 생성이라고 아는 것보다 요청한 데이터를 처리한다고 하는 것이 더 적절한 표현이다.

 

• 메시지 바디를 통해 서버로 요청 데이터를 전달
• 서버는 요청 데이터를 처리 : 메시지 바디를 통해서 들어온 데이터를 처리하는 모든 기능을 수행
• 주로 전달된 데이터로 신규 리소스를 등록 || 프로세스 처리에 사용 

 

동작 순서

1. 클라에서 서버에게 메시지를 전달한다.
2. 서버에 메시지가 도착하면, 신규 리소스를 생성해서 
3. 리소스 + 메서드를 바탕으로 해당하는 응답 데이터를 전달한다.

 

🤔 요청 데이터를 처리한다는 것의 의미?

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

 

예를 들어서

HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공 
-> HTML FORM에 입력된 정보로 회원 가입, 주문 등에 사용

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

서버가 아직 식별하지 않은 새 리소스 생성
-> 신규 주문 생성

기존자원에 데이터 추가
-> 한 문서 끝에 내용 추가 

✅ 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 한다. (= 정해진 것이 없다.)

 

✅ POST  

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

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

 

2. 요청 데이터 처리

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

(ex, 주문 > 결제완료 > 배달 시작 > 배달 완료 처럼 단순히 값 변경을 넘어서 프로세스 상태가 변하는 경우)

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

(ex, POST /orders/{orderId}/start-delivery .. 컨트롤 URI)

 

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

: 애매하면 POST !!!

 

PUT

리소스를 대체

• 리소스가 있다면? 대체 (= 덮어버림)
• 리소스가 없다면? 생성 

🔴 클라이언트가 리소스를 식별한다.

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

= POST와의 차이점 

 

위의 그림과 같은 경우처럼 필드를 하나 생략하고 PUT을 하면 그 리소스에 대해서는 필드가 생략된 상태로 덮어씌워진다.

 

PATCH

리소스 부분 변경 

위의 그림에서 만약 PATCH로 보냈다면 해당 필드만 변경된다.

 

DELETE

리소스 제거 

 

HTTP 메서드의 속성 

• 안전 (= Safe Methods)
• 멱등 (= Idempotent Methods)
• 캐시가능 (= Cachables Methods)

 

안전

클라이언트가 계속 호출해도 리소스를 변경하지 않는다.

 

🤔 만약 계속 호출해서 로그 등이 쌓여 장애가 발생한다면?

-> 안전은 해당 리소스만 고려할 뿐, 로그 등과 같은 부분까지 고려하지 않는다.

 

멱등 

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

 

멱등한 HTTP 메서드?

- GET : 1번, 2번 .. 100번 조회 모두 같은 결과

- PUT : 결과를 대체, 여러번 요청해도 같은 결과 

- DELETE : 결과를 삭제, 여러번 요청해도 최종 결과는 해당 리소스 삭제로 동일

- POST : 멱등 X, 여러 번 호출 시 중복 결제와 같은 결과가 나올 수 있다.

 

🤔 재요청 중간에 다른 곳에서 리소스를 변경한다면?

(= 사용자 1이 GET을 요청하고 다시 재요청을 하기 전에 사용자 2가 PUT을 한다면?)

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

 

언제 활용하는가?
- 자동 복구 메커니즘
- 서버가 타임아웃 등으로 정상 응답을 주지 못할 때, 클라이언트가 같은 요청을 다시 해도 되는가? 
(GET, PUT, DELETE의 경우 가능 / POST는 불가) 

 

캐시가능 

응답 결과 리소스를 캐시해서 사용해도 되는가?
- GET, HEAD, POST, PATCH 캐시 가능 
- 실제로는 POST, PATCH 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않으므로 GET / HEAD만