모든 개발자를 위한 HTTP 웹 기본 지식_섹션4_HTTP_메서드

1. HTTP를 만들어보자.

• 아래의 기능을 할 수 있는 HTTP API를 만든다고 가정해보자.
  • 회원 목록 조회
  • 회원 조회
  • 회원 등록
  • 회원 수정
  • 회원 삭제

초보개발자 아무개가 위 기능에 대해 api path를 어떻게 이름 지을지 고민하다 음 그래 역시 뭐든 의도가 분명하게 적어야지! 라며 다음과 같이 정한다고 가정해보자.

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

음 그래,, URI 이름의 동사를 보면 의도가 분명하여 함수 메소드라고 생각하면 잘 지었다고 생각할 수 있다.
하지만 과연 옳게 지었는가? 이것이 과연 좋은 URL 설계인가?(실제로 이렇게 URL 설계를 많이 한답니다 😅)

가장 중요한 것은 리소스 식별!!!!!!!!!

API URL 고민

URL(Uniform Resource Identifier)

• 리소스의 의미는 뭘까?
  • 회원을 등록하고 수정하고 조회하는게 리소스가 아니다!
  • 예) 미네랄을 캐라! -> 미네랄이 리소스
  • 회원이라는 개념 자체가 리소스다! -> 회원이 리소스!
• 리소스를 어떻게 식별하는게 좋을까?
  • 회원을 등록하고 수정하고 조회하는 것을 모두 배제
  • 회원이라는 리소스만 식별하면 된다. -> 회원 리소스를 URI에 매핑

이게 리소스(볼드처리한 것)다, URI에는 리소스인 members + {id} 만 들어간다.

• 회원 목록 조회 /members
• 회원 조회 /members/{id} -> 어떻게 구분하지?
• 회원 등록 /members/{id} -> 어떻게 구분하지?
• 회원 수정 /members/{id} -> 어떻게 구분하지?
• 회원 삭제 /members/{id} -> 어떻게 구분하지?

근데 조회, 등록, 수정, 삭제 api의 URL가 같은데... 어떻게 구분하지?? 🧐

리소스(명사)와 행위(동사)를 분리

가장 중요한 것은 리소스를 식별하는 것

• 리소스: 회원
• 행위: 조회, 등록, 삭제, 변경
• 리소스는 명사, 행위는 동사
• 행위(메소드)는 어떻게 구분?

HTTP 메서드는 클라이언트가 서버에 요청을 할 때 기대하는 행동이다.

HTTP 메서드 종류

• GET: 리소스 조회 (representation 설명 전이라 리소스로 표현합니다)
• POST: 요청 데이터 처리, 주로 등록에 사용
• PUT: 리소스를 대체, 해당 리소스가 없으면 생성
• PATCH: 리소스 부분 변경
• DELETE: 리소스 삭제

2. HTTP 메서드 - GET, POST

GET

• 리소스 조회
• 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링) 를 통해서 전달
• 메시지 바디를 사용해서 데이터를 전달할 수 있지만(하지만 하지 않는다. 심지어 최근 스펙에서는 지원하지 않는다), 지원하지 않는 곳이 많아서 권장하지 않음

POST

• 요청 데이터 처리
• 메시지 바디를 통해 서버로 요청 데이터 전달(필수다. 꼭 기억하자)

{
    "username": "hello",
    "age": 20
}

• 서버는 요청 데이터를 처리
  • 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
• 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
• 클라이언트가 POST 로 요청하면 서버는 보통 아래와 같이 Response 를 준다(201 Created, Location: /members/100).

POST - 요청 데이터를 어떻게 처리한다는 뜻일까?

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

POST - 정리

1. 새 리소스 생성(등록)
   • 서버가 아직 식별하지 않은 새 리소스 생성
2. 요청 데이터 처리
   • 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
     • 예) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우 POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
     • 예) POST /orders/{orderId}/start-delivery (컨트롤 URI)
3. 다른 메서드로 처리하기 애매한 경우
   • 예) JSON으로 조회 데이터를 넘겨야 하는데(즉 조회라서 GET인데 httpBody에 JSON 데이터를 실어서 넘겨야 하는 경우), GET 메서드를 사용하기 어려운 경우 애매하면 POST

GET 으로 쓰면 유리한 지점이 있다.
-> 보통 서버끼리는 GET 으로 온 request는 캐싱을 한다. 반면에 POST로 온 request 는 캐싱하기 어렵다.

3. HTTP 메서드 - PUT, PATCH, DELETE

PUT

• 리소스를 대체
  • 리소스가 있으면 대체
  • 리소스가 없으면 생성
  • 쉽게 이야기해서 덮어버림(말그대로 put! 얹다, 덮다) 완전히 대체한다.
• 중요! 클라이언트가 리소스를 식별
  • 클라이언트가 리소스 위치를 알고 URI 지정(post와 달리 id가 100인 리소스가 이미 있다?!)
  • 이게 POST와의 차이점이다.

PUT은 수정하는 것이 아니라 아예 갈아치우는 것이다.

PATCH

• 리소스 부분 변경

{
  "username": "young",
  "age": 20
}

=> 이제 여기에서 age만 50으로 부분 변경이 가능하다.

NOTE: PATCH가 지원이 안되는 서버들도 있다. 그럴땐 POST를 쓰자. POST는 무적이라고 했다!

DELETE

• 리소스 제거

4. HTTP 메서드의 속성

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

1. 안전

Safe

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

2. 멱등

Idempotent

• f(f(x)) = f(x)
• 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.
• 멱등 메서드
  • GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 요청된다.
  • PUT: 결과를 대체 한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
  • DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
  • POST(따라서 잘 다뤄야 한다): 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.(매우 큰일난 상황)
• 활용
  • 자동 복구 메커니즘
  • 서버가 TIMEOUT 등으로 정상 응답을 못 주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가? 판단 근거 👍
• Q: 재요청 중간에 다른 곳에서 리소스를 변경해버리면?
  • 사용자1: GET -> username:A, age:20
  • 사용자2: PUT -> username:A, age:30
  • 사용자1: GET -> username:A, age:30 -> 사용자2의 영향으로 바뀐 데이터 조회
• A: 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지는 않는다.

3. 캐시가능

Cachable

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