[HTTP] #4. HTTP 메서드 - 김영한(인프런)

bien·2023년 6월 18일

HTTP

목록 보기

4/7

HTTP API를 만들어보자

요구사항

회원 목록 조회, 회원 조회, 회원 등록, 회원 수정, 회원 삭제 기능을 갖춘 회원 정보 관리 API를 만들라는 요청이 있다. 초보자로 막 설계를 시작한 나는 무엇부터 시작할까 고민하던 와중, 각 기능마다 이름을 먼저 결정하기로 한다.

API URI 설계

URI(Uniform Resource Identifier)

- 회원 목록 조회 /read-member-list
- 회원 조회 /read-member-by-id
- 회원 등록 /create-member
- 회원 수정 /update-member
- 회원 삭제 /delete-member

각 기능에 맞춰 적절하게 이름을 붙인것처럼 보인다. 이것은 좋은 URI 설계일까? 그렇지 않다.

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

API URI고민

리소스의 의미는 뭘까? 회원을 등록하고 수정, 조회하는 것이 리소스가 아니다. "미네랄을 캐라"라는 요청이 있었다면, 미네랄이 리소스이다. 이전의 요청사항에서는 회원이라는 개념 자체가 바로 리소스이다.
리소스를 어떻게 식별하는 것이 좋을까? 회원을 등록하고 수정, 조회하는 것은 모두 배제한다. 회원이라는 리소스만 식별하면 되는 것이다. 따라서, 회원 리소스를 URI에 매핑한다.

API URI 설계

리소스 식별, URI 계층 구조

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

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

회원이라는 리소스에만 집중하면, 구분이 어려워진다.

리소스와 행위를 분리

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

URI는 리소스만 식별한다. 리소스(회원)와 해당 리소스를 대상으로 하는 행위(조회, 등록, 삭제, 변경)을 분리해야 한다. 리소스는 명사, 행위는 동사를 의미한다. 행위(메서드)는 어떻게 구분해야 할까?

HTTP 메서드 - GET, POST

클라이언트가 서버에 요청할 때 기대하는 행동.

HTTP 메서드 종류 - 주요 메서드

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

최근에는 리소스라는 표현이 representation으로 바뀜

HTTP 메서드 종류 - 기타 메서드

거의 사용하지 않는다.

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

GET

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

리소스 조회1. 메시지 전달

클라이언트에서 GET 방식으로 "/memger/100" 데이터를 요청한다.

리서스 조회2. 서버 도착

서버에서 해당 데이터를 조회한다.

리서스 조회3. 응답 데이터

서버에서 해당 경로의 정보를 HTTP 응답 메시지 바디에 담아 응답한다.

POST

클라이언트에서 서버측에 정보를 전달하며 처리를 요청하는 것.

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

리소스 등록1. 메시지 전달

post방식으로 정보를 전달한다.

리소스 등록2. 신규 리소스 생성

서버에서 신규 리소스 식별자를 생성하여 클라이언트가 보내준 데이터를 등록한다.

리소스 등록3. 응답데이터

보통 신규로 데이터가 등록된경우 201 status-code와 자원이 등록된 주소를 Location으로 보내준다.

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

POST 메서드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함 된 표현을 처리하도록 요청한다.
POST가 사용되는 기능은 다음과 같다.

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

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

POST 정리

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

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

2. 요청 데이터 처리

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

자원만 URI로 설계하는 것이 권장되나, 이는 이상적인 것이고, 리소스만으로 설계가 힘든 경우 행위(동사)의 URI가 나올 수 있다. 이를 컨트롤 URI라 하고, 실무에서는 사용되곤 한다.

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

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

📌 요약
POST는 메시지 바디에 담아 모든일을 할 수 있다! 그러나, 조회와 관련된 최적화에는 GET 메서드를 통해 적용되어 있으므로, 조회에는 GET을 사용하고 그 외의 상황에는 POST를 사용하면 된다!

HTTP 메서드 - PUT, PATCH, DELETE

PUT

리소스를 "완전히" 대체

리소스가 있으면 대체
리소스가 없으면 생성
=> 쉽게 이야기해서 덮어버림

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

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

보내는 요청 HTTP 메시지에서 "/members/100"이라고 리소스를 알고 이를 메시지로 전송한다.

PUT - 리소스가 있는 경우


PUT하는 경로에 기존 데이터가 저장되어 있는 경우	데이터가 새로운 데이터로 "대체"된다.

PUT - 리소스가 없는 경우


PUT하는 경로에 데이터가 없는 경우	데이터가 새로 입력된다.

PUT - 리소스를 "완전히" 대체한다.


기존의 데이터에서 age만 변경할 목적으로 필드 중 일부만 전송한다.	예상과 달리, 해당 리소스에 내가 전송한 정보만 저장된다. 수정이 아니라 "완전히 대체되었다."

이처럼 특정 필드의 값만 변경하고 싶을땐 어떻게 하면 될까?

PATCH

리소스 부분 변경


필드 중 변경하고자 하는 값만 전송	내가 수정하고자 하는 리소스만 부분 변경된다.

DELETE

리소스 제거

HTTP 메서드의 속성

get은 데이터 조회. head는 get과 똑같은데 body부분만 뺀것.

안전 Safe Methods

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

get은 조회만하기에 리소스에 변경이 일어나지 않는다. 그러나 생성, 수정, 삭제가 가능한 post, update, delete같은 경우 반복적으로 실행된다면 문제가 발생할 수 있다. 이같은 특징을 안전이라고 한다. 반복으로 인해 야기될 수 있는 로그 축적 등은 고려하지 않고, 리소스만 고려하는 개념이다.

멱등 Idempotent Methods

f(f(x)) = f(x)
한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.
멱등 메서드
- GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
- PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
- DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
- POST: 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
활용
자동 복구 메커니즘. (DELETE했는데 서버에서 응답이 없어 클라이언트가 재신청하는 경우, 문제가 되지 않는다._
외부 요인으로 중간에 리소스가 변경되는것 까지는 고려하지 않는다.

캐시가능 Cacheable Methods

웹 브라우저에 큰 이미지를 요청했을때, 이를 다시 요청할 필요가 없다. 웹 브라우저가 내부에 이 큰 이미지를 저장할 수 있는가.=캐시가능

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

캐시를 위해서는 똑같은 리소스라는 키가 같아야 한다. post는 바디안에 데이터가 많아 이런 키까지 고려하기가 힘들어 대부분 구현이 안되어 있다. get은 url만 고려하여 키를 확인할 수 있어 캐시로 사용하기 용이하다.

정리

HTTP API를 만들어보자.
API URI 설계: 리소스와 행위를 분리 + URI는 리소스만 식별한다.
리소스(회원) + 행위(조회, 등록, 삭제, 변경) = 중복. 분리의 어려움
=> HTTP메서드를 통해 "행위"를 표기한다.
HTTP 메서드: GET, POST
GET: 리소스 조회. 메시지 바디 X
POST: 요청 데이터 처리. 메시지 바디 O.
HTTP 메서드: PUT, PATCH, DELETE
PUT: 리소스를 "완전히" 대체 + 클라이언트가 리소스를 식별
PATCH: 리소스의 부분 변경
DELETE: 리소스 삭제
HTTP 메서드의 속성: 안전, 멱등, 캐시가능
안전: 호출해도 리소스를 변경하지 않는다.; get, head
멱등: 몇번을 호출하든 결과가 동일하다.;get, head, put, delete
캐시가능: get, head, ~~(post)~~

bien

Good Luck!

이전 포스트

[HTTP] #3. HTTP 기본 - 김영한(인프런)

다음 포스트

[HTTP] #4. HTTP 메서드 - 김영한(인프런)

HTTP

HTTP API를 만들어보자

요구사항

API URI 설계

URI(Uniform Resource Identifier)

API URI고민

API URI 설계

리소스 식별, URI 계층 구조

리소스와 행위를 분리

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

HTTP 메서드 - GET, POST

HTTP 메서드 종류 - 주요 메서드

HTTP 메서드 종류 - 기타 메서드

GET

리소스 조회1. 메시지 전달

리서스 조회2. 서버 도착

리서스 조회3. 응답 데이터

POST

리소스 등록1. 메시지 전달

리소스 등록2. 신규 리소스 생성

리소스 등록3. 응답데이터

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

POST 정리

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

2. 요청 데이터 처리

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

HTTP 메서드 - PUT, PATCH, DELETE

PUT

리소스를 "완전히" 대체

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

PUT - 리소스가 있는 경우

PUT - 리소스가 없는 경우

PUT - 리소스를 "완전히" 대체한다.

PATCH

리소스 부분 변경

DELETE

리소스 제거

HTTP 메서드의 속성

안전 Safe Methods

멱등 Idempotent Methods

캐시가능 Cacheable Methods

정리

[HTTP] #3. HTTP 기본 - 김영한(인프런)

[HTTP] #5. HTTP 메서드 활용- 김영한(인프런)

0개의 댓글