[HTTP 웹 기본 지식] HTTP 메서드

해당 글은 김영한님의 '모든 개발자를 위한 HTTP 웹 기본 지식' 강의를 수강하고 중요한 내용을 정리하고 보충한 글입니다.

 

 

1. HTTP API 만들기

HTTP API를 설계하는 것은 중요하면서도 기초적이고 필수적인 과정이다.

이번 글에서는 회원이라는 개념을 리소스로 간주하여 이를 URI에 매핑하고, 리소스와 행위를 분리하는 방법을 설명한다.

 

1) API URI 설계 - 리소스 식별

여기서는 회원이라는 개념 자체가 바로 리소스이다.

회원이라는 리소스만 식별 -> 회원 리소스를 URI에 매핑

 

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

 

그런데 회원 조회/등록/수정/삭제의 경우 URI들이 같다. 이것을 어떻게 구별해야 할까? 🤔

 

참고
계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장
ex) member -> members

 

 

2) 리소스와 행위를 분리

`1) API URI 설계 - 리소스 식별`에서 봤듯이 URI는 리소스만 식별한다.

그렇기에 우리는 리소스와 해당 리소스를 대상으로 하는 행위을 분리해야 한다.

 

• 리소스: 회원
• 행위: 조회, 등록, 삭제, 변경

 

그리고 이제 행위는 HTTP 메서드를 통해 분리해준다.

 

---

2. HTTP 메서드 - GET, POST

1) 주요 메서드 소개

• GET: 리소스 조회
• POST: 요청 데이터 처리, 주로 등록에 사용
• PUT: 리소스를 대체, 해당 리소스가 없으면 생성
  • 파일과 비슷하게 기존 리소스가 있으면 덮어버리고 없으면 생성한다
• PATCH: 리소스 부분 변경
• DELETE: 리소스 삭제

 

 

2) GET

GET /search?q=hello&hl=ko HTTP/1.1 
Host: www.google.com

 

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

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

 

 

3) POST

POST /members HTTP/1.1 
Content-Type: application/json
{
    "username": "hello", 
    "age": 20
}

메시지 바디를 통해 서버로 요청 데이터 전달하면 처리한다.

• 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
• 다른 메서드로 처리하기 애매한 경우에는 보통 POST 메서드를 사용한다
  • ex) JSON으로 조회 데이터를 넘겨야 하지만 지원 문제로 GET 메서드를 사용하기 어려울 때

 

정리
POST 메서드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청한다.
-> 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 한다.

 

 

4) PUT

PUT /members/100 HTTP/1.1 
Content-Type: application/json
{
    "username": "hello", 
    "age": 20
}

해당 메서드는 리소스를 대체(덮어버림)한다. 만약 리소스가 없다면 생성한다.

• POST와 달리 클라이언트가 리소스를 식별한다
  • 클라이언트가 리소스 위치(/100)를 알고 URI 지정 -> 클라이언트가 100번에 넣을거라고 지정을 함
  • 위의 PUT 예시를 보면 100번이라는 멤버가 있다면 덮어버리고 없다면 생성
• 리소스를 완전히 대체한다
  • 위의 예시에서 나이만 바꾸고 싶어 `"age": 50`만 보낸다면 `username` 필드가 삭제됨
  • 만약 부분 수정하고 싶다면 PATCH 사용

 

 

5) PATCH

PATCH /members/100 HTTP/1.1 
Content-Type: application/json
{
   "age": 50 
}

PUT 메서드와 달리 리소스를 부분 변경할 수 있다.

 

 

6) DELETE

DELETE /members/100 HTTP/1.1 
Host: localhost:8080

해당 리소스를 제거한다.

 

 

---

3. HTTP 메서드의 속성

HTTP 메서드의 속성은 안전(Safe Methods), 멱등(Idempotent Methods), 캐시가능(Cacheable Methods)으로 나뉜다.

 

출처: https://ko.wikipedia.org/wiki/HTTP

 

 

1) 안전

GET이나 HEAD 메서드 처럼 호출해도 리소스를 변경하지 않는 메서드를 safe라 한다.

 

• 그래도 계속 호출해서, 로그 같은게 쌓여서 장애가 발생하면?
  • 안전은 해당 리소스만 고려한다. 그런 부분까지 고려하지 않는다.

 

 

2) 멱등

한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같은 것을 말한다.

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

 

✔️ 재요청 중간에 다른 곳에서 리소스를 변경해버리면?

• ex) 사용자1: GET -> username:A, age:20
• ex) 사용자2: PUT -> username:A, age:30
• ex) 사용자1: GET -> username:A, age:30 -> 사용자2의 영향으로 바뀐 데이터 조회
• 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지는 않는다.

 

멱등이 필요한 이유

자동 복구 메커니즘때문이다.
만약 서버가 TIMEOUT 등으로 정상 응답을 못주면, 클라이언트가 같은 요청을 다시 해도 되는가를 판단할 때 근거가 된다. 

  

 

3) 캐시 가능

응답 결과 리소스를 캐시해서 사용해도 되는가를 나타낸다.

GET, HEAD, POST, PATCH 캐시 가능하지만 실제로는 GET, HEAD 정도만 캐시로 사용한다.

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