신주용

신주용

Software Engineer

HTTP 메서드

업데이트:

API URI 설계

리소스 식별, URI 계층 구조 활용해야 한다.

리소스의 의미

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

리소스 식별 방법

  • 회원을 등록하고 수정하고 조회하는 것을 모두 배제
    • create-member X
    • read-member-by-id X
  • 회원이라는 리소스만 식별하면 된다.
    • 회원 리소스를 URI에 매핑

설계 방법

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

HTTP 메서드

GET

  • 리소스 조회
  • 서버에 전달하고 싶은데이터는 query string을 통해서 전달
  • 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아 권장하지 않음
  • 요청 메시지
    • GET /member/100 HTTP1.1 HOST:localhost:8080
    • member 100을 요청
  • 응답 메시지
    • HTTP/1.1 200 OK … {“username”: “jshin”, “age”:31}

POST

  • 요청 데이터를 처리
  • 메시지 바디를 통해 서버로 요청 데이터 전달
  • 서버는 요청 데이터를 처리
    • 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
  • 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
  • 요청 메시지
    • POST /member HTTP1.1 HOST:localhost:8080 {“username”: “jshin”, “age”:31}
    • /members로 오면 신규등록을 가정함
  • 신규 리소스 생성
    • /member/100 : 신규리소스 생성, {“username”: “jshin”, “age”:31}
  • 응답 데이터
    • HTTP/1.1 201 Created … Location:/members/100 {“username”: “jshin”, “age”:31}

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

  • HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
    • HTML form에 입력한 정보로 회원가입, 주문 등..
  • 게시판, 뉴스, 블로그 .. 등 그룹에 메시지 게시
    • 게시판 글쓰기, 댓글달기
  • 서버가 아직 식별하지 않는 새 리소스 생성
    • 신규 주문 생성
  • 기존 자원에 데이터 추가
    • 한 문서 끝에 내용 추가하기

POST 정리

  1. 새 리소스 생성
    • 서버가 아직 실벽하지 않은
  2. 요청 데이터 처리
    • 단순데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
    • 결제완료 > 배달시작 > 배달완료 와 같이 값 변경을 넘어 프로세스의 상태가 병경되는 경우
    • POST의 결과로 새로운 리소스가 생성되지 않을 수 있음
    • POST /orders/{orderId}/start-delivery(컨트롤 URI), 리소스만 가지고 설계는 불가능할 수 있다, 행동을 정의
  3. 다른 메서드로 처리하기 애매한 경우
    • JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
    • 애매하면 POST

PUT

  • 리소스가 있으면 대체 없으면 생성, 덮어버림
  • 클라이언트가 리소스를 식별
    • URI 위치를 알고 정확하게 지정해야한다.
    • POST는 와의 차이점 이다.
  • 메시지
    • PUT /members/100 HTTP/1.1 … {“username”: “hshin”, “age”:24}
    • /members/100 이 있으면 덮어씌움 {“username”: “jshin”, “age”:31} > {“username”: “hshin”, “age”:24}
    • 없으면 새로 생성
    • 기존의 리소스를 없애고 다시 만든다고 생각하면됨

PATCH

  • 리소스의 부분변경
  • 메시지
    • PATCH /members/100 HTTP/1.1 … {“age”:24}
    • /members/100의 부분을 변경 {“username”: “jshin”, “age”:31} > {“username”: “hshin”, “age”:24}
    • 없으면 새로 생성
  • PATCH를 지원하지 않는 경우는 POST 사용

DELETE

  • 리소스 제거
  • 메시지
    • PATCH /members/100 HTTP/1.1
    • 삭제됨

기타 메서드

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

HTTP 메서드의 속성

안전(Safe)

  • 호출해도 리소스를 변경하지 않는다.
  • GET, HEAD
  • 계속해서 호출해서 로그같은게 쌓이면
    • 이런 부분까지 고려하지 않는다.

멱등(Idempotent)

  • 한번 호출하든 N번 호출하든 결과가 같아야 한다.
  • 멱등 메서드
    • GET : 몇번 조회하든 같은 결과가 조회된다.
    • PUT : 결과를 대체한다. 같은 요청을 여러번 해도 항상 같은 값으로 덮는다
    • DELETE : 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
  • POST는 멱등이 아니다. 두번 호출시 같은 결제가 중복해서 일어난다.
  • 자동 복구 메커니즘에 사용가능하다.
  • 재 요청 중간에 리소스를 변경하면 데이터는 바뀌지만 멱등은 외부 요인으로 변경되는 것까지는 고려하지 않는다.

캐시가능(Cacheable)

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

태그:

카테고리:

업데이트:

댓글남기기

참고