[F-Lab 모각코 챌린지 13일차] HTTP 메서드

Nami·2023년 6월 13일
GETHTTP APIHTTP 메서드POSTdeletef-labhttppatchput모각코
0

66일 포스팅 챌린지

목록 보기
13/66
post-custom-banner

HTTP

HTTP API

회원 정보 관리 API를 만들라는 요구사항이 왔을 경우,
회원 목록 조회, 등록, 수정, 삭제 등.

처음 API URI 설계시 이렇게 짜는 경우가 있다.
회원 목록 조회 /read-member-list
회원 조회 /read-member-by-id
회원 등록 /create-member
회원 수정 /update-member
회원 삭제 /delete-member

이는 좋은 URI 설계일까?

API URI를 설계할 때 가장 중요한 것은 리소스 식별이다.

리소스의 의미

리소스의 의미는 뭘까?

회원을 등록, 수정, 조회할 경우, 리소스는 회원이라는 개념 자체이다.

리소스의 식별

리소스를 어떻게 식별하는게 좋을까?
회원을 등록하고 수정하고 조회하는 것을 모두 배제한다.

회원이라는 리소스만 식별하면된다. ➡️ 회원 리소스를 URI에 매핑.

URI 계층 구조 활용
⭐️ 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장(member -> members)

회원 목록 조회 /members
회원 조회 /members/{id} ➡️ 어떻게 구분하지?
회원 등록 /members/{id} ➡️ 어떻게 구분하지?
회원 수정 /members/{id} ➡️ 어떻게 구분하지?
회원 삭제 /members/{id} ➡️ 어떻게 구분하지?

URI는 리소스를 식별하는데에 쓰면 됨. 행위를 판별하는데에 쓰면 안됨.
리소스와 해당 리소스를 대상으로 하는 행위를 분리

  • 리소스: 명사 (회원 등)
  • 행위(메서드): 동사 (조회, 등록, 삭제, 변경)

HTTP 메서드 종류

주요 메서드

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

⭐️ 리소스로 표기 했지만 최근 스펙에선 Representation으로 바뀜

기타 메서드

  • HEAD: GET과 동일하지만 메시지 부분을 제외하고 상태 줄과 헤더만 반환.
  • OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)

GET

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

POST

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

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

  • 스펙: 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청함.
  • 예시
    • HTML 양식에 입력된 field와 같은 데이터 블록을 데이터 처리 프로세스에 제공
      (HTML FORM에 입력한 정보로 회원가입, 주문 등)
    • 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
      (게시판 글쓰기 댓글 달기)
    • 서버가 아직 식별하지 않은 새 리소스 생성
      (신규 주문 생성)
    • 기존 자원에 데이터 추가
      (한 문서 끝에 내용 추가하기)

이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야함 ➡️ 정해진 것이 없음

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

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

2. 요청 데이터 처리

  • 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야하는 경우
  • 예시: 주문에서 결제완료 ➡️ 배달시작 ➡️ 배달완료처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
  • POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
  • 예시: POST /orders/{orderId}/start-delivery (컨트롤 URI)

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

  • JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
    • 조회 데이터는 최대한 GET, 계획 변경 및 프로세스 변경시 POST
  • 애매하면 POST

PUT

  • 리소스를 대체
    • 리소스가 있으면 완전히 대체 ➡️ 업데이트가 아님..! 수정 X
    • 리소스가 없으면 생성
    • 쉽게 얘기해서 덮어버린다는 뜻.
  • ⭐️ 클라이언트가 리소스를 식별 ⭐️
    - 클라이언트가 리소스 위치를 알고 URI 지정
    • POST와 차이점

PATCH

  • 리소스 부분 변경
  • 지원이 안되는 서버가 있긴함. 그런 경우 POST

DELETE

  • 리소스 제거

HTTP 메서드 속성

안전 Safe

  • 호출해도 리소스를 변경하지 않는다.
  • Q: 그래도 계속 호출해서, 로그 같은 것이 쌓여서 장애가 발생한다면?
  • A: 안전은 해당 리소스만 고려한다.

멱등 Idempotent

  • f(f(x)) = f(x)

  • 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.

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

  • 활용

    • 자동 복구 매커니즘
    • 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가?에 대한 판단 근거.

  • Q: 재요청 중간에 다른 곳에서 리소스를 변경해버리면?

    • 사용자 1: GET username: A, age: 20
    • 사용자 2: PUT username: A, age: 30
    • 사용자 1: GET username: A, age: 30 (사용자 2의 영향으로 바뀐 데이터 조회)

  • A: 멱등은 외부 요인으로 중간에 리소스가 변경되는 것은 고려하지 않는다.

캐시가능 Cacheable

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

🤔💭

강의 섹션 4를 우선 정리했다. 5도 오늘 같이 수강할 것이다. 정리는 내일 할 것 같다. 현재 블로그 정리 방식을 고민 중이라, 이번 강의를 전부 완강한 후에 재정립을 해볼 예정. 챌린지와 멘토링을 같이 병행할 방법을 생각 중!

참조 ✅

profile
Nami
이전 포스트

[F-Lab 모각코 챌린지 12일차] 모든 것이 HTTP

다음 포스트

[F-Lab 모각코 챌린지 14일차] HTTP 메서드 활용

post-custom-banner

0개의 댓글