개발 공부/http

HTTP 메서드

Summer_berry 2023. 4. 9. 17:39

API URI 설계

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

 

회원 목록조회 /read-member-list -> /members

회원 조회 /read-member-by-id -> /members/{id}

회원등록 /create-member -> /members/{id}

회원수정 /update-member -> /members/{id}

회원삭제 /delete-member -> /members/{id}

 

uri 설계시 가장 중요한것은 리소스 식별이다.

리소스의 의미

  • 회원을 등록하고 수정하고 조회하는게 리소스가 아니다.
  • 회원이라는 개념 자체가 바로 리소스다.

리소스를 어떻게 식별밥법

  • 회원이라는 리소스만 식별하면 된다-> 회원 리소스를 URI에 매핑

 

리소스와 행위를 분리

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

 

HTTP 메서드

주요 메서드

GET: 리소스 조회

POST: 요청 데이터 처리, 주로 등록에 사용

PUT: 리소스를 대체, 해당 리소스가 없으면 생성

PATCH: 리소스 부분 변경

DELETE: 리소스 삭제

 

기타메서드

HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환

OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명

 

 

GET

  • 리소스 조회
  • 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달

 

POST

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

 

post 요청 처리

1. 새 리소스 생성(등록)

2. 요청 데이터 처리

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

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

  • JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
  • 애매하면 POST

 

PUT

리소스를 대체

  • 리소스가 있으면 대체 없으면 생성
  • 쉽게 이야기하면 덮어버림

리소스가 있는 경우

리소스가 통채로 대체됨

주의! 리소스를 완전히 대체한다. 수정되는게 아니라  리소스 전체가 보낸 데이터로 바뀜.

 

리소스가 없는 경우

신규 리소스 생성 

 

중요! 클라이언트가 리소스를 식별

  • 클라이언트가 리소스 위치를 알고 URI 지정
  • POST와 차이점

 

PATCH

리소스 부분 변경

patch 를 받지 못하는 서버일때는 Post 사용

 

DELETE

리소스 제거

 

 

 

HTTP 메서드의 속성

안전(safe)

호출해도 리소스를 변경하지 않는다.

리소스 부분만 고려한 안전.

 

멱등(Idempotent)

  • 한번 호출하든 두번 호출하든 100번 호출하든 결과가 똑같다.
  • 멱등은 외부 요인으로 인해 중간에 리소스가 변경되는것 까지는 고려하지는 않음.

멱등 메서드

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

활용

  • 자동 복구 메커니즘
  • 서버가 timeout 등으로 정상 응답을 못 주었을때, 클라이언트가 같은 요청을 다시해도 되는지 판단하는 근거가 됨.
  • 멱등 메서드라면 클라이언트가 같은 요청을 여러번 시도해도 됨.

 

캐시가능(cacheable)

응답 결과 리소스를 캐시해서 사용해도 되는가?

GET, HEAD, POST, PATCH 캐시가능

실제로는 GET, HEAD 정도만 캐시로 사용

POST, PATCH는 본문 내용까지 캐시 키로 고려해야하는데 , 쉽지 않다