[HTTP][모든 개발자를 위한 HTTP 웹 기본 지식] - HTTP 메서드

💻본 포스팅은 '모든 개발자를 위한 HTTP 웹 기본 지식 - 김영한'님의 강의를 듣고 작성되었습니다.
https://inf.run/kXeZ

모든 개발자를 위한 HTTP 웹 기본 지식 - 인프런 | 강의

---

[요구사항 - 회원 정보 관리 API를 만들어라]

• 회원 목록 조회
• 회원 조회
• 회원 등록
• 회원 수정
• 회원 삭제

 

위와 같이 회원 정보 관리 API를 만들 때 세부사항을 나눌 수 있다고 할 때 어떻게 URI를 설계해야 좋은 설계일까?

 

 

[리소스 식별]

URI 설계에서 가장 중요한 것은 리소스의 식별이다. 

 

이때 리소스란 무엇일까?? 

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

[참고 사항]

계층 구조상 상위 컬렉션으로 보고 복수단어 사용을 권장한다. (member -> members)

 

[리소스와 행위를 분리]

URI 설계에서 가장 중요한 것은 리소스와 행위를 분리하는 것이다.

• URI는 리소스만 식별한다.

 

• 리소스와 해당 리소스를 대상으로 하는 행위를 분리
  • 리소스: 회원
  • 행위: 조회, 등록, 삭제, 변경

 

• 리소스는 명사, 행위는 동사

 

• 행위(메서드)는 어떻게 구분?

 

 

 

[HTTP 메서드 종류]

주요 메서드

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

[GET]

리소스 조회

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

메시지 바디를 사용해서 데이터를 전달할 수 있고, 지원하지 않는 곳이 많아 권장하지 않는다.

 

[POST]

• 1. 새 리소스 생성(등록)
  • 서버가 아직 식별하지 않은 새 리소스 생성

 

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

 

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

 

[PUT]

• 리소스 대체
  • 리소스가 없으면 생성
  • 리소스가 있으면 완전히 대체(덮어쓰기) -> 부분 변경의 개념이 아니다.

 

• 클라이언트가 리소스를 식별 (중요!!)
  • 클라이언트가 리소스 위치를 알고  URI 지정 -> POST와의 차이점

 

[PATCH]

• 리소스 부분 변경

 

[DELETE]

• 리소스 제거

 

 

 

[HTTP 메서드의 속성]

• 안전
  • 호출해도 리소스를 변경하지 않는다. 
  • 같은 것은 계속 호출해서 로그가 쌓여 장애가 발생하는 등의 문제는 고려하지 않는다. (안전은 해당 리소스만 고려하기 때문이다.)

 

• 멱등(Idempotent Methods)
• 한 번 호출을 하든 두 번 호출을 하든 100번 하든 결과가 같은 것을 멱등이라 한다.
• 멱등 메서드
  • GET
  • PUT
  • DELETE
  • POST의 경우엔 멱등이 아니다. 두 번 호출 시 같은 결제가 중복해서 발생할 수 있기 때문이다.

 

• 멱등 메서드가 사용되는 곳
  • 자동 복구 매커니즘
  • 서버가 타임아웃 등으로 정상 응답을 주지 못할 때, 클라이언트가 같은 요청을 다시 해도 되는가에 대한 판단 근거가 된다.
  • 재요청 중간에 다른 곳에서 리소스를 변경한다면? -> 멱등은 외부 요인으로 중간 리소스가 바뀌는 것까지 고려하지 않는다.

 

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