모든 개발자를 위한 HTTP 웹 기본 지식(4) - HTTP 메서드 및 활용

❤️ HTTP 메서드

HTTP API 만들기

⭐ URI 설계 시 가장 중요한 것은 리소스 식별

리소스 식별, URI 계층 구조 활용

• 리소스의 의미
  • 회원을 등록하고 수정하고 조회하는 것 ❌
    예) 미네랄을 캐라 -> 미네랄이 리소스
  • 회원이라는 개념 자체가 바로 리소스!!
• 리소스 식별
  • 회원을 등록하고 수정하고 조회하는 것을 모두 배제
  • 회원이라는 리소스만 식별하면 됨 -> 회원 리소스를 URI에 매핑

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

리소스와 행위를 분리

• URI는 리소스만 식별
• 리소스와 해당 리소스를 대상으로 하는 행위를 분리
  • 리소스 : 회원
  • 행위 : 조회, 등록, 삭제, 변경
• 리소스는 명사, 행위는 동사
• 행위(메서드)는 어떻게 구분?
  • HTTP 메서드로 구분

💡 HTTP 주요 메서드

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

💡 HTTP 기타 메서드

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

HTTP 메서드 - GET

• 리소스 조회
• 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해 전달
• 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음
• 리소스 조회1 - 메시지 전달
  
• 리소스 조회2 - 서버도착
  요청에 대해 조회 후 데이터 생성
  
• 리소스 조회3 - 응답 데이터
  서버에서 응답 메시지를 만들어 클라이언트에 전달
  

HTTP 메서드 - POST

• 요청 데이터 처리
• 메시지 바디를 통해 서버로 요청 데이터 전달
• 서버는 요청 데이터를 처리
  • 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행
• 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 이용
• 리소스 등록1 - 메시지 전달
  
• 리소스 등록2 - 신규 리소스 생성
  
• 리소스 등록3 - 응답 데이터
  

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

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

POST 사용 정리

• 새 리소스 생성(등록)

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

• 요청 데이터 처리

  • 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
    예) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 병경되는 경우

  • POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
    예) POST/orders/{orderId}/start-delivery (컨트롤 URI)

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

  • 예) JSON으로 조회 데이터를 넘겨야 하는데 GET메서드를 사용하기 어려운 경우
  • 애매해면 POST
  • 조회할 데이터는 최대한 GET을 사용할 것!

HTTP 메서드 - PUT

• 리소스를 대체
  • 리소스가 있으면 대체
  • 리소스가 없으면 생성
  • 즉, 덮어버림
• ⭐ 클라이언트가 리소스를 식별
  • 클라이언트가 리소스 위치를 알고 URI 지정
  • POST와 차이점
• 리소스가 있는 경우1
  
• 리소스가 있는 경우2
  기존의 리소스가 대체된다
  
• 리소스가 없는 경우1
  
• 리소스가 없는 경우2
  신규 리소스가 생성된다
  
• ⚠️ 리소스를 완전히 대체한다1
  
• ⚠️ 리소스를 완전히 대체한다2
  기존의 리소스가 삭제되고 완전히 대체된다
  

HTTP 메서드 - PATCH

• 리소스 부분 변경
• 리소스를 수정하고 싶을 경우 사용
• 지원이 안되는 경우 POST 사용
• 리소스 부분 변경1
  
• 리소스 부분 변경2
  

HTTP 메서드 - DELETE

• 리소스 제거
• 리소스를 삭제하고 싶을 경우 사용

HTTP 메서드의 속성

안전(Safe Methods)

• 호출해도 리소스를 변경하지 않는다
• 호출했을 때 변경이 일어나지 않는 경우 '안전'
• 계속 호출해서 로그가 쌓여 장애가 발생할 경우는 고려하지 않는다
• 안전은 해당 리소스만 고려

멱등(Idempotent Methods)

• f(f(x)) = f(x)
• 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다
• 멱등 메서드
  • GET : 몇 번을 조회하든 같은 결과가 조회된다
  • PUT : 결과를 대체하므로 같은 요청을 여러번 해도 최종 결과는 같다
  • DELETE : 결과를 삭제하므로 같은 요청을 여러번 해도 삭제된 결과는 똑같다
  • POST : 멱등❌, 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다
• 활용
  • 자동 복구 메커니즘
  • 서버가 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 된다
• 외부 요인으로 중간에 리소스가 변경되는 것까지는 고려❌

캐시가능(Cacheable Methods)

• 응답 결과 리소스를 캐시에서 사용해도 되는가?
• GET, HEAD, POST, PATCH 캐시가능
• 실제로는 GET, HEAD정도만 캐시가능
  • POST, PATCH는 본문 내용까지 캐시 키로 고려해야 함(구현 어려움)

❤️ HTTP 메서드 활용

클라이언트에서 서버로 데이터 전송

1. 쿼리 파라미터를 통한 데이터 전송

• GET
• 주로 정렬 필터(검색어)

2. 메시지 바디를 통한 데이터 전송

• POST, PUT, PATCH
• 회원 가입, 상품 주문, 리소스 등록, 리소스 변경

4가지 상황

• 정적 데이터 조회
  
  • 이미지, 정적 텍스트 문서
  • 조회는 GET 사용
  • 일반적으로 쿼리 파리미터 없이 리소스 경로로 단순하게 조회 가능
    
    
• 동적 데이터 조회
  
  • 주로 검색, 정렬 필터(검색어)
  • 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용
  • 조회는 GET 사용
  • 쿼리 파라미터 사용하여 데이터 전달
    
    
• HTML Form을 통한 데이터 전송
  • POST 전송 (저장)
    ✔️ form의 내용을 메시지 바디를 통해 전송
    ✔️ 전송 데이터를 url encoding 처리
    
  • GET 전송 (조회)
    ✔️ 쿼리 파라미터 형식으로 전송
    
  • multipart/form-data
    ✔️ 파일 업로드 같은 바이너리 데이터 전송 시 사용
    ✔️ 다른 종류의 여러 파일과 폼의 내용 함께 전송 가능
    
• HTTP API를 통한 데이터 전송
  • 서버 to 서버 - 백엔드 시스템 통신
  • 앱 클라이언트 - 아이폰, 안드로이드
  • 웹 클라이언트 - 자바스크립트를 통한 통신(AJAX)
  • POST, PUT, PATCH : 메시지 바디를 통해 데이터 전송
  • GET : 조회, 쿼리 파라미터로 데이터 전달
  • Content-Type: application/json을 주로 사용

HTTP API 설계 예시

HTTP API - 컬렉션

예시) 회원 관리 시스템

회원 목록 /members -> GET
회원 등록 /members -> POST
회원 조회 /members/{id} -> GET
회원 수정 /members/{id} -> PATCH, PUT, POST
회원 삭제 /members/{id} -> DELETE

• POST 기반 등록
  • 클라이언트는 등록될 리소스의 URI를 모른다
    • POST/members
  • 서버가 새로 등록된 리소스 URI를 생성해준다
    • HTTP/1.1 Created
Location: /members/100
  • 컬렉션(Collection)
    • 서버가 관리하는 리소스 디렉터리
    • 서버가 리소스의 URI를 생성하고 관리함
    • /members
• 대부분 POST기반의 컬렉션을 사용

HTTP API - 스토어

예시) 파일 관리 시스템

파일 목록 /files -> GET
파일 조회 /files/{filename} -> GET
파일 등록 /files/{filename} -> PUT
파일 삭제 /files/{filename} -> DELETE
파일 대량 등록 /files -> POST

• PUT 기반 등록
  • 클라이언트가 리소스 URI를 알고 있어야 한다
    • PUT/files/start.jpg
  • 클라이언트가 직접 리소스의 URI를 지정한다
  • 스토어(Store)
    • 클라이언트가 관리하는 리소스 저장소
    • 클라이언트가 리소스의 URI를 알고 관리
    • /files

HTML FORM 사용

예시) 순수 HTML FORM을 사용할 경우

회원 목록    /members -> GET
회원 등록 폼 /members/new -> GET
회원 등록    /members/new, /members -> POST
회원 조회    /members/{id} -> GET
회원 수정 폼 /members/{id}/edit -> GET
회원 수정    /members/{id}/edit, /members/{id} -> POST
회원 삭제    /members/{id}/delete -> POST (컨트롤 URI)

• GET, POST만 지원
• 컨트롤 URI
  • GET, POST만 지원하므로 제약이 있기때문에 사용
  • 동사로 된 리소스 경로 사용
  • POST의 /new, /edit, /delete
  • HTTP 메서드만드로 해결하기 애매한 경우 사용
• AJAX 사용

💡 참고하면 좋은 URI 설계 개념
https://restfulapi.net/resource-naming/

출처 - 인프런 '모든 개발자를 위한 HTTP 웹 기본 지식' 강의