[HTTP] HTTP 메서드

[HTTP] HTTP 메서드

---

API URI 설계 -> 리소스 식별, URI 계층 구조 활용

 

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

문제점: 조회, 등록, 수정, 삭제 구분 불가

-> 리소스와 행위(조회,등록,수정,삭제)를 분리함으로써 해결

---

HTTP 메서드 종류

method 종류	내용
GET	리소스 조회
POST	요청 데이터 처리, 주로 등록에 사용
PUT	리소스를 대체, 해당 리소스가 없으면 생성
PATCH	리소스 부분 변경
DELETE	리소스 삭제
HEAD	GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
OPTIONS	대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)

 

GET

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

POST

• 요청 데이터 처리
• 메시지 바디를 통해 서버로 요청 데이터 전달
• 서버는 요청 데이터를 처리
  • 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
• 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
• 스펙: 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청
  • HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
  • 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
  • 서버가 아직 식별하지 않은 새 리소스 생성
  • 기존 자원에 데이터 추가
• 정리: 이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야함 (정해진 것이 없음)
  • 1) 새 리소스 생성(등록)
  • 2) 요청 데이터 처리 (단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야하는 경우)
    • 새로운 리소스가 생성되지 않을 수도 있음
    • control URI -> POST의 /new, /edit, /delete ( HTML Form은 GET,POST만 지원하기 때문에 control URI 활용 )
  • 3) 다른 메서드로 처리하기 애매한 경우
    • JSON으로 조회 데이터를 넘겨야하는데, GET 메서드를 사용하기 어려운 경우
    • 애매하면 POST

PUT

• 리소스를 완전히 대체 (있으면 대체, 없으면 생성)
  • 대체될 때 기존 filed는 전부 사라지고 새로운 정보로 대체된다!
• 클라이언트가 리소스를 식별!! -> PUT /members/100 (POST와 차이점)

PATCH

• 리소스를 부분 변경

DELETE

• 리소스를 제거

---

POST vs PUT ( 신규 자원 등록 특징 )

 

POST

• 클라이언트는 등록될 리소스의 URI를 모른다. ( POST /members )
• 서버가 새로 등록된 리소스 URI를 생성해준다.
• 컬렉션
  • 서버가 관리하는 리소스 디렉토리
  • 서버가 리소스의 URI를 생성하고 관리
  • 여기서 컬렉션은 /members

PUT

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

---

HTTP 메서드의 속성

• 안전(safe)
  • 호출해도 리소스를 변경하지 않는다.
• 멱등(idempotent)
  • 한 번 호출하든 100번 호출하든 결과가 똑같다.
  • 멱등 메서드: GET, PUT, DELETE
  • 활용: 자동 복구 메커니즘 -> 서버가 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시  해도 되는가? 판단 근거
• 캐시가능(Cacheable)
  • 응답 결과를 캐시에서 사용해도 되는가?
  • GET, HEAD, POST. PATCH 캐시가능
  • 실제로는 GET, HEAD 정도만 캐시로 사용 -> (POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하기 때문)

---

HTML Form 데이터 전송

• HTML Form submit시 POST 전송
• Content-Type: application/x-www-form-urlencoded 사용
  • form의 내용을 메시지 바디를 통해서 전송(key-value 형태)
  • 전송 데이터를 url encoding처리
• HTML Form은 GET 전송도 가능
• Content-Type: multipart/form-data
  • 파일 업로드 같은 바이너리 데이터 전송시 사용
  • 다른 종류의 여러 파일과 폼의 내용 함께 전송 가능
• 참고) HTML Form 전송은 GET, POST만 지원

---

HTTP API 데이터 전송 ( HTTP Form을 사용하지 않는 모든 경우 )

• 서버 to 서버
  • 백엔드 시스템 통신
• 앱 클라이언트
  • 아이폰, 안드로이드
• 웹 클라이언트
  • HTML에서 Form 전송 대신 자바 스크립트를 통한 통신에 사용(AJAX)
  • 예) React, VueJs 같은 웹 클라이언트와 API 통신
• POST, PUT, PATCH: 메시지 바디를 통해 데이터 전송
• GET: 조회, 쿼리 파라미터로 데이터 전달
• Content-Type: application/json 주로 사용(표준)
  • TEXT, XML, JSON 등

 

참고사이트

 

https://restfulapi.net/resource-naming 

REST Resource Naming Guide - REST API Tutorial