TIL

HTTP 메서드

회원 정보 관리 API 예시

가장 중요한 것은 리소스 식별

• 리소스의 의미
  • 회원을 등록하고 수정하고 조회하는 것이 리소스가 아님
  • ex) 회원을 등록해라 → 회원이 리소스
  • 회원이라는 개념 자체가 리소스
• 리소스 식별을 어떻게?
  • 회원 등록, 수정, 조회하는 것을 모두 배제
  • 회원이라는 리소스만 식별하면 된다. → 회원 리소스를 URI에 매핑

URI 설계

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

참고: 계층 구조상 상위를 컬렉션으로 보고 복수 단어 사용 권장

조회, 등록, 수정, 삭제를 어떻게 구분?

리소스와 행위를 분리

가장 중요한 것은 리소스를 식별하는 것

• URI는 리소스만 식별!
• 리소스와 리소스를 대상으로 하는 행위를 분리
  • 리소스: 회원
  • 행위: 조회, 등록, 삭제, 변경
• 행위는 HTTP 메서드로 구분

HTTP 메서드 종류

주요 메서드

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

기타 메서드

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

GET

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

POST

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

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

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

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

  POST 정리

  1. 리소스 생성(등록)
  2. 요청 데이터 처리
  3. 단순히 데이터 생성을 넘어 프로세스를 처리하는 경우
  4. ex) 주문에서 결제 완료 → 배달 시작 → 배달 완료처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
  5. POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
  6. ex) POST/orders/{orderId}/start-delivery
  7. 리소스만으로 설계해야 하지만 어쩔 수 없이 리소스만으로 안될 때가 있다.

  8. 위 예처럼 /start-delivery 같은 동사(행위)를 컨트롤 URI라고 함

     

  9. 다른 메서드로 처리하기 애매한 경우
  10. ex) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
  11. 애매하면 POST

사실 POST는 모든 걸 할 수 있지만 단순 조회는 GET을 쓰자.

리소스를 생성하거나, 뭔가 프로세스가 진행 되서 서버에 변화를 주거나 정말 어쩔 수 없는 경우에 POST를 사용할 수 있다.

PUT

• 리소스 대체
  • 리소스가 있으면 대체
  • 리소스가 없으면 생성
  • 쉽게 이야기해서 덮어버림
• 중요! 클라이언트가 리소스를 식별
• 클라이언트가 리소스 위치를 알고 URI 지정

• POST와 차이점

• 100번 리소스에 대해 PUT 요청을 보내면 100번 리소스의 데이터가 완전히 대체된다.
• 리소스가 없는 경우 생성한다.*
• 주의! 리소스를 완전히 대체한다! 데이터의 일부만 보내면 그 데이터는 사라짐

PATCH

• 리소스 부분 변경

DELETE

리소스 제거

HTTP 메서드 속성

• 안전하다
• 멱등하다
• 캐시 가능하다

안전 (safe)

• 호출해도 리소스를 변경하지 않는다.
• GET은 안전

멱등 (Idempotent)

• f(f(x)) = f(x)
• 한 번 호출하든 n번 호출하든 결과가 똑같다.
• 멱등 메서드
  • GET: 한 번 조회하든, 두 번 조회하든 결과가 같다.
  • PUT: 결과를 대체한다. 몇 번 대체하든 최종 결과물은 같다.
  • DELETE: 결과를 삭제한다. 여러 번 삭제해도 결과는 같다.
  • POST: 멱등이 아니다! 데이터가 중복 저장될 수 있다.
• 활용
  • 자동 복구 메커니즘
  • 서버가 TIMEOUT 등으로 정상 응답을 못 주었을 때 클라이언트가 중복 요청 보내도 되는가에 대한 판단 근거

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

• GET → username:A, age:20
• PUT → username:B, age:30
• GET → username:A, age:20

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

캐시 가능

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