[HTTP] HTTP 메소드, GET, POST, PATCH, PUT, DELETE, 안전, 멱등

1. HTTP API를 만들어보자

인프런 김영한 님의 모든 개발자를 위한 HTTP 웹 기본 지식 강의를 듣고 내용을 정리한 글입니다.

주로 사용되는 HTTP 메서드는

크게 get, post, put, patch, delete 5가지가 있다.

메서드의 속성

회원정보관리 API를 만들어야 한다면, API URI를 아래와 같이 설계할 수 있다.

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

이렇게 URI를 설계하는 것 그리 좋지 않다.

가장 중요한 것은 리소스 식별인데, 위와 같이 하면 이 식별이 어렵기 때문이다.

그렇다면 리소스는 뭘까?

등록하고, 수정하고, 조회하는 게 리소스가 아니다.

회원이 리소스다.

그럼 리소스를 어떻게 식별해야 할까?

등록하고 수정하고 조회하는 것은 모두 URI에서 배제하고, 리소스만 남긴다.

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

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

리소스는 명확해졌는데 조회, 등록, 수정, 삭제 등 행위를 어떻게 구분할까?

메소드로 구분한다.

즉, HTTP API URI를 설계할 때는 리소스와 행위를 분리해야 한다.

• URI: 리소스
• 메소드: 리소스를 대상으로 하는 행위

2. HTTP 메서드 - GET, POST

HTTP 메소드는 쉽게 말해 클라이언트가 서버에게 요청을 할 때 서버가 해줄 것이라 기대하는 행동이다.

예) GET은 리소스를 달라, POST는 클라가 데이터를 줄 테니 서버야 처리 좀 해줘.

HTTP 메소드 종류

주요 메소드

• GET: 리소스 조회
• POST: 요청 데이터 처리. 주로 등록에 사용. 클라가 반드시 데이터를 담아서 서버에게 전해줘야 한다.
• PUT: 리소스 대체. 해당 리소스가 없으면 생성. 클라가 보내는 데이터로 대체.(예: 폴더에 파일 넣는 것)
• PATCH: 리소스 부분 변경.
• DELETE: 리소스 삭제.

기타 메서드

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

GET

• 리소스 조회
• 서버에 전달하고 싶은 데이터는 쿼리 파라미터 등을 통해서 전달한다.
• 최근 HTTP 스펙에서는 메세지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 서버 등이 많아서 권장하지 않음

POST

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

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

HTTP 스펙에는 POST 메소드에 대해 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청합니다, 라고 적혀있다.

예를 들면

1. HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스 제공
2. 게시판 글쓰기, 댓글 달기
3. 서버가 아직 식별하지 않은 새 리소스 생성(신규 주문, 회원 생성)
4. 기존 자원에 데이터 추가

등이 있고,

특정 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 한다.

1. 새 리소스 생성(등록)
2. 요청 데이터 처리(결졔완료 -> 배달시작 -> 배달완료처럼 단순히 값 변경이 아닌 프로세스의 상태가 변경)
   • post의 결과로 새로운 리소스가 생성되지 않을 수도 있음
   • /orders/{orderId}/start-delivery (배달 시작. 컨트롤 URI)
3. 다른 메소드로 처리하기 애매한 경우
   • JSON으로 조회 데이터를 넘겨야 하는데, GET 메소드를 사용하기 어려운 경우(get 메소드에 메세지 바디를 지원하지 않는 서버일 때)
   • 사실 POST로는 모든 걸 할 수 있기 때문에, 애매하면 POST를 사용한다.
   • 조회할 때는 GET으로 하면 캐싱이 쉬움(POST는 조회 및 캐싱이 가능하다 어려움)

즉, CRUD에서 C를 POST로 처리하고, RUD를 제외한 모든 것을 POST로 처리하면 된다.

3. HTTP 메서드 - PUT, PATCH, DELETE

PUT

• 리소스를 완전히 대체한다.
• 리소스가 있으면 대체, 없으면 생성.
• 쉽게 말해 덮어버림(예: 폴더에 파일 넣는 것)
• 클라이언트가 리소스를 식별

클라이언트가 구체적인 리소스 위치를 알고 URI를 지정한다. POST와 가장 큰 차이.

예를 들어

• PUT /members/100: 100번 회원 정보를 이렇게 대체해줘
• POST /members: 이 정보를 member에 만들어줘! -> 서버가 알아서 다음 id에 정보 넣음

주의할 점은,

PUT은 리소스를 완전히 대체하는 것이기 때문에 부분 수정이 불가능하다.

예) 기존 데이터가 {name: fadf, age: 40} 일 때 { age: 50 } 를 PUT으로 보내면

name이 날아가고 { age:50 }로 변경된다.

사실 PUT은 수정이라기보다는 대체. 갈아치우기에 가깝다.

PATCH

• 리소스 부분 변경

예) 기존 데이터가 { name: fadf, age: 40 } 일 때 { age: 50 } 를 PATCH로 보내면

{ name: fadf, age:50 }와 같이 age만 변경된다.

만약 서버가 PATCH를 지원하지 않는다면 POST를 쓰면 된다.

DELETE

• 리소스 제거

4. HTTP 메서드의 속성

HTTP 메서드의 속성으로는 크게 세 가지가 있다.

• 안전 safe methods
• 멱등 idempotent methods
• 캐시가능 cacheable methods

안전

리소스를 변경하지 않는다.

• GET 안전
• POST, PUT, PATCH, DELETE 안전하지 않음

그래도 계속 호출해서 로그 같은 게 쌓여서 장애가 발생하면?

안전은 리소스만 고려함. 그런 건 고려하지 않는다.

멱등

같은 요청을 한 번 호출하든 두 번 호출하든 백 번 호출하든 결과가 똑같으면 멱등

• GET: 계속 조회해봤자 리소스 안 변함. 멱등
• PUT: 결과를 대체한다. 따라서 같은 요청을 여러번해도 최종결과는 같다. 멱등
• DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 같다. 멱등

POST 멱등 아님. 두 번 호출하면 같은 결제가 중복해서 발생 가능.

멱등이라는 개념은 왜 있는 걸까?

자동복구 메커니즘. 서버가 타임아웃등으로 정상 응답을 못줬을 때 클라이언트가 같은 요청을 다시해도 되는가? 의 판단 근거가 된다.

즉 GET, PUT, DELETE 등은 다시 요청해도 된다.

재요청 중간에 다른 곳에서 리소스를 변경해버리면? 외부요인으로 중간에 리소스가 변경되는 것까지는 멱등 여부를 판단하는 데 고려하지 않는다.

PATCH의 경우

PATCH는 설계에 따라 멱등이기도 하고 아니기도 한다.

예를 들어

아래와 같이 name을 "kim"으로 바꾸기만 하는 경우 PATCH 이지만 멱등이다

{ name: "kim" }

반면에 operation이라는 key값이 "add"일 때, "age"의 값만큼 더해주는 API를 PATCH로 설계하면 이는 멱등이 아니다.

{ "operation": "add", "age": 10"}

정리하면 PATCH는 리소스의 특정 부분을 변경하는데, 이 변경 방식이 멱등이어도 되고, 멱등이 아니어도 된다.

캐시가능

응답 결과 리소스를 캐시해서 사용해도 되는가? 에 관한 속성

GET, HEAD, POST, PATCH 캐시 가능

실제로는 GET, HEAD정도만 캐시로 사용한다.

POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않다.