[모든 개발자를 위한 HTTP 웹 기본 지식] 4. 메서드

 

API URI 고민

URI = 리소스 + 해당 리소스를 대상으로 하는 행위

1. 리소스 = 회원(/members)
   • 명사
   • 계층 구조상 상위를 컬렉션으로 보고, 복수단어 사용 권장(member → members)
   • 최근에는 리소스 → 표현(representation)으로 용어가 변경됨
2. 메서드 = 조회, 등록, 삭제, 변경
   • 동사
   • 리소스를 식별함

 

HTTP 메서드

주요 메서드

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

기타 메서드

• HEAD: GET과 동일하나, 메시지 부분만 제외하고 상태 줄과 헤더만 반환
• OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)를 설명(주로 CORS에서 사용)
• (CONNECT): 대상 자원으로 식별되는 서버에 대한 터널을 설정
• (TRACE): 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행

 

GET

• 리소스 조회
• 서버에 전달하고 싶은 데이터는 쿼리(query, 쿼리 파라미터, 쿼리 스트링)를 통해 전달
• 메시지 바디를 사용해서 데이터를 전달은 할 순 있으나, 대부분 지원하지 않으므로 권장X

POST

• 요청 데이터 처리
• 메시지 바디를 통해 서버로 요청 데이터를 전달함
• 서버는 요청 데이터를 처리함
  • 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행함
• 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
• POST의 기능들
  1. 새 리소스 생성(등록)
     • 서버가 아직 식별하지 않은 새 리소스 생성
  2. 요청 데이터 처리
     • 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
       • ex. 주문에서 결제완료 → 배달 시작 → 배달완료처럼 단순히 값 변경을 넘어 프로세스 상태가 변경되는 경우
     • POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
       • ex) POST /orders/{orderId}/start-delivery
  3. 다른 메서드로 처리하기 애매한 경우
     • JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
     • 애매하면 POST
  ⇒ 리소스 URI에 POST 요청에 온다면, 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함 = 즉, 정해진 것이 없음
• ⇒ POST는 모든 것을 할 수 있다! (하지만 조회는 GET을 쓰자)

PUT

• 리소스를 대체
  • 리소스 있으면 대체(replace)
  • 리소스 없으면 생성(create)
  • = 덮어버림!
    • ex.
      • 서버 {age:50, name:’heo’}
      • 클라이언트 PUT {age: 20}
      • 서버 {age:20} → name이 사라짐
• [중요!] 클라이언트가 리소스를 식별함
  • 클라이언트가 리소스 위치를 알고 URI 지정함
    • ex. PUT /members/100
  • POST와 차이점

PATCH

• 리소스 부분 변경
• 요즘은 거의 다 지원되지만, 혹시나… 일부 지원 안되기도 함. 이럴 땐 POST를 쓰자

DELETE

• 리소스 제거

 

 

HTTP 메서드의 속성

 

안전(Safe Methods)

• 호출해도 리소스를 변경하지 않음
• 단, 리소스만 고려함. 계속 호출해서 로그가 쌓여 발생하는 장애 같은 것은 고려X
  • ex. GET - safe, 나머지는 unsafe

멱등(Idempotent Methods)

• f(f(x)) = f(x)
• 한 번 호출하든, 두 번 호출하든, 100번 호출하든 결과가 동일함
• 멱등 메서드
  • GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회됨
  • PUT: 결과를 대체함(덮음). 즉 같은 요청을 여러 번 해도 최종 결과는 동일
  • DELETE: 결과를 삭제함. 즉 같은 요청을 여러 번 해도 삭제된 최종 결과는 동일
  • POST: 멱등이 아님. 두 번 호출하면 같은 결제가 중복해서 발생할 수 있음
    • 절대 두 번 발생하면 안됨!
• 활용
  • 자동 복구 메커니즘
  • 서버에게서 TIMEOUT 등으로 정상 응답을 못 받았을 때 클라이언트가 같은 재요청함
• 만약 재 요청 중간에 다른 곳에서 리소스가 변경된다면?
  • 사용자1: GET → username: A, age: 20
  • 사용자2: PUT → username: A, age: 30
  • 사용자3: GET → username: A, age: 30 → 사용자2의 영향으로 바뀐 데이터가 조회됨
  • ⇒ 멱등은 외부 요인으로 중간에 리소스가 변경되는 것까지는 고려하지 않음

 

캐시 가능(Cacheable Methods)

• 응답 결과, 리소스를 캐시해서 사용할 수 있는가?
  • ex. 웹브라우저가 이미지를 저장하고 있을 수 있느냐
• 캐시 가능: GET, HEAD, POST, PATCH
• 실제로는 GET, HEAD 정도만 캐시로 사용 가능
  • 왜냐하면 캐시를 하려면 key가 동일해야 함. 하지만 POST, PATCH는 본문 내용(body)까지 캐시 키로 고려해야 하므로 캐시로 구현이 쉽지 않음
  • 반면, GET은 본문 내용(body)가 없고 URI만 key로 잡으면 되므로 simple하여 구현이 쉬움