이 글은 [모든 개발자를 위한 HTTP 웹 기본 지식]을 듣고 정리한 내용입니다
📌 HTTP API 만들어보기
- HTTP API를 만들 때 중요한것은 리소스 식별이다.
- 리소스의 의미 - 행위가 아니라, 개념 자체가 리소스다
ex) '회원 조회' 가 아니라 '회원' 자체가 리소스다.
- 리소스만 식별해서 리소스를 URI에 매핑하자.
ex) API URI 설계
요구사항 : 회원 정보 관리 API 만들기.
\
📌 HTTP 메서드 - GET, POST
🌱 HTTP 메서드 종류
주요 메서드
- GET: 리소스 조회
- POST: 요청 데이터 처리, 주로 등록에 사용
- PUT: 리소스를 대체, 해당 리소스가 없으면 생성
- PATCH: 리소스 부분 변경
- DELETE: 리소스 삭제
기타 메서드
- HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태줄(시작 라인)과 헤더만 반환
- OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
- CONNECT: 대상 자원으로 식별되는 서버에 대한 터널을 설정 (잘 안씀)
- TRACE: 대상 리소스에 대한 경로를 따라 메세지 루프백 테스트를 수행 (잘 안씀)
🌱 GET
![](https://media.vlpt.us/images/somyeong0623/post/97dfd270-e87d-4b42-9087-e6c19b725b17/image.png)
- 리소스 조회
- 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)을 통해서 전달
- 메세지 바디를 사용해서 데이터를 전달할 수는 있지만, 지원하지 않는 곳이 많아서 권장하지 않음.
🌱 POST
![](https://media.vlpt.us/images/somyeong0623/post/04c0b26a-44e6-4fd0-bc71-7f793182b6be/image.png)
- 요청 데이터 처리
- 메시지 바디를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리
- 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
- 컨트롤 URI 사용: 세부적인 분류가 필요한 경우 사용
- ex) POST /orders/{orderId}/start-delivery(컨트롤 URI)
- 다른 메서드로 처리하기 애매한 경우
-ex) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우, 애매한 경우 그냥 POST로 처리.
요청 데이터를 어떻게 처리? - POST가 사용되는 기능들
- HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
- ex) HTML FORM에 입력한 정보로 회원가입, 주문 등 진행
- 게시판, 뉴스그룹, 메일링 리스트, 블로그 또는 유사 기사 그룹에 메세지 게시
- 서버가 아직 식별하지 않은 새 리소스 생성
- 기존 자원에 데이터 추가
- *정리: 이 리소스 URI에 POST요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 한다. -> 정해진 것이 없음.
📌 HTTP 메서드 - PUT, PATCH, DELETE
🌱 PUT
![](https://media.vlpt.us/images/somyeong0623/post/a567f9dd-5fb5-44f3-910f-d50371f5359e/image.png)
- 리소스를 대체
- 리소스가 있으면 대체
- 리소스가 없으면 생성
- 클라이언트가 리소스를 식별한다
- 클라이언트가 리소스 위치를 알고 URI 지정
- POST에서는 /member 였다면 PUT은 /members/100 -> 이렇게 클라이언트는 정확한 리소스 위치를 알고 그것을 지정함.
- PUT은 리소스를 '완전히' 대체하는 것에 주의하자.
![](https://media.vlpt.us/images/somyeong0623/post/c16d55a0-919b-40b9-b6fa-982c2bb416fe/image.png)
![](https://media.vlpt.us/images/somyeong0623/post/1442f245-da28-49a3-a9e9-66d1016dad1b/image.png)
🌱 PATCH
- 완전히 변경하는게 아니라, 부분만 변경하고 싶은 경우 PATCH를 사용한다
![](https://media.vlpt.us/images/somyeong0623/post/494981c8-27b7-4d9c-8779-24e2030a2df3/image.png)
![](https://media.vlpt.us/images/somyeong0623/post/142de66b-86de-4c6a-a569-1f5fa2ae2b5f/image.png)
- *PATCH가 지원이 안되는 경우 (그런 서버들도 있음) -> POST 사용. (POST는 무적이다)
🌱 DELETE
- 리소스를 제거한다.
![](https://media.vlpt.us/images/somyeong0623/post/e82012c8-4869-48e4-bcac-39a8231ce636/image.png)
![](https://media.vlpt.us/images/somyeong0623/post/ae5108ad-2c59-4a76-972b-c0e668f4fb58/image.png)
📌 HTTP 메서드의 속성
- 안전(Safe Methods)
- 멱등(Idempotent Methods)
- 캐시가능(Cacheable Methods)
![](https://media.vlpt.us/images/somyeong0623/post/95add983-ac12-4b97-9bff-f92ce3cf4a23/image.png)
🌱 안전
- 호출해도 리소스를 변경하지 않는다. -> 그래서 안전하다!!
(계속 호출해서 로그 쌓이는 것 까진 고려하지 않는다. (안전에서 만큼은) )
🌱 멱등
- f(f(X)) = f(x)
- 한 번 호출하던 백 번 호출하던 결과가 같다.
- 멱등 메서드
- GET: 한 번 조회하던, 여러번 조회하던 같은 결과가 조회된다.
- PUT: 결과를 대체한다. 같은 요청을 여러번 해도 같은 결과로 대체되므로 치종결과는 같다.
- DELETE: 결과를 삭제한다. 같은 요청을 여러번 하면, 같은 정보가 삭제되므로 최종 결과는 같다.
- POST: 멱등이 아니다!! 예를 들어, 결제 api를 여러번 호출하면 결제가 중복해서 발생할 수 있다.
멱등의 활용
- 자동 복구 매커니즘에서 자주 이용된다.
- 서버가 TIMEOUT 등으로 정상 응답을 못했을때, 클라이언트가 같은 요청을 다시해도 되는지에 대한 판단 근거가 된다.
- 외부 요인으로 중간에 리소스가 변경되는 것 까지는 멱등 내에서의 고려 요인이 아니다.
🌱 캐시 가능
- 응답 결과 리소스를 캐시해서 사용해도 되는가?
- GET, HEAD, POST, PATCH -> 캐시 가능하다
- 실제로는 GET, HEAD 정도만 캐시로 사용한다.
- POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않다.