HTTP 메서드
모든 개발자를 위한 HTTP 웹 기본 지식 - 인프런 | 강의
실무에 꼭 필요한 HTTP 핵심 기능과 올바른 HTTP API 설계 방법을 학습합니다., 웹 기술을 사용하는 개발자라면 누구나 OK!꼭 필요한 HTTP의 핵심을 알려드립니다. 📣 확인해주세요!본 강의는 자바 스
www.inflearn.com
강의를 들으며 생각 정리
HTTP API를 만들어보자
HTTP 메서드에 대해 공부하기에 앞서 다음과 같은 HTTP API를 만든다고 하자.
요구사항
회원 정보 관리 API를 만들어라.
- 회원 목록 조회
- 회원 조회
- 회원 등록
- 회원 수정
- 회원 삭제
이제 각 기능들의 URI를 설계한다.
- 회원 목록 조회 /read-member-list
- 회원 조회 /read-member-by-id
- 회원 등록 /create-member
- 회원 수정 /update-member
- 회원 삭제 /delete-member
이것은 좋은 URI 설계일까? -> X, URI 설계에서 가장 중요한 것은 리소스 식별이다.
리소스의 의미는 무엇일까? -> 회원 등록이 리소스가 아니라 회원이라는 개념 자체가 바로 리소스다.
즉, 회원이라는 리소스만 식별하면 된다.
- 회원 목록 조회 /members
- 회원 조회 /members/{id}
- 회원 등록 /members/{id}
- 회원 수정 /members/{id}
- 회원 삭제 /members/{id}
+) 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용을 권장한다.(member->members)
URI를 보면 회원 목록 조회를 제외한 나머지의 경우 id로서 members를 관리한다는 의미인데, 그렇다면 각각을 어떻게 구분하면 좋을까?
리소스와 행위를 분리
- URI는 리소스만 식별! -> 가장 중요한 것은 리소스를 먼저 식별하는 것이다.
- 리소스와 해당 리소스를 대상으로 하는 행위를 분리
- 리소스 : 회원
- 행위 : 조회, 등록, 삭제, 변경
- 리소스는 명사, 행위는 동사
그렇다면 행위는 어떻게 구분할까? -> 이를 메서드라고 표현하는데 다음 내용에서 알아보자.
HTTP 메서드 - GET, POST
GET
리소스 조회
서버에 전달하고 싶은 데이터는 query를 통해서 전달
+) 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않는다.
ex)
GET /members/100 HTTP/1.1
Host: localhost:8080
-> /members/100의 정보를 조회한다.
응답데이터 예시
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 34
{ "username": "young", "age": 20 }
POST
요청 데이터 처리
메시지 바디를 통해 서버로 요청 데이터 전달
서버는 요청 데이터를 처리
주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용한다.
ex)
POST /members HTTP/1.1
Content-Type: application/json
{ "username": "young", "age": 20 }
응답 데이터 예시
HTTP/1.1 201 Created // 보통 신규 리소스 생성은 201 코드를 사용한다.
Content-Type: application/json
Content-Length: 34
Location: /members/100 // 신규 리소스 생성 위치
{ "username": "young", "age": 20 }
POST 메서드 사용 정리
- 새 리소스 생성(등록) : 서버가 아직 식별하지 않은 새 리소스 생성
- 요청 데이터 처리 : 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우 (단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우) -> 요청 데이터를 어떻게 처리할지 리소스마다 정해줘야 한다. 예) POST /orders/{orderId}/start-delivery (컨트롤 URI : 리소스만으로 프로세스 처리를 명시하기 까다로울 때 사용하는 추가적인 URI)
- 다른 메서드로 처리하기 애매한 경우 : JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우 -> 애매하면 POST가 좋다.
HTTP 메서드 - PUT, PATCH, DELETE
PUT
리소스가 있으면 대체
리소스가 없으면 생성
-> 쉽게 이야기해서 덮어버림
ex)
PUT /members/100 HTTP/1.1 -> 클라이언트가 리소스를 식별한다는 점이 POST와 중요한 차이점 중 하나다.
Content-Type: application/json
{ "username": "old", "age": 50 }
주의
PUT 메서드는 리소스를 완전히 대체한다. 즉, "age": 50 데이터 만을 보낸 경우 회원의 username이 사라진다.
PATCH
PUT 메서드는 리소스를 완전히 대체하는 반면에 PATCH 메서드는 리소스 부분 변경을 지원한다.
ex)
PATCH /members/100 HTTP/1.1
Content-Type: application/json
{ "age": 50 } -> age 필드만 변경
+) 간혹 PUT, PATCH 메서드를 지원하지 않는 서버도 있는데 이 때는 그냥 POST 메서드를 사용하면 된다.
DELETE
리소스 제거
ex)
DELETE /members/100 HTTP/1.1
Host: localhost:8080
HTTP 메서드의 속성
안전
호출해도 리소스를 변경하지 않는다.
ex) GET
멱등
한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.
ex)
GET : 여러 번 조회해도 같은 결과가 조회된다.
PUT : 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
DELETE : 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
POST : 멱등이 아니다. 주문 시스템의 경우 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
+) PATCH의 경우 부분 필드를 수정하는데 만약 어떤 필드 값을 10씩 더하는 기능이라면 멱등을 만족하지 않는다.
활용
자동 복구 메커니즘 : 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가?
한계
재요청 중간에 다른 곳에서 리소스를 변경해버리면?
->
사용자1: GET -> username:A, age:20
사용자2: PUT -> username:A, age:30
사용자1: GET -> username:A, age:30 -> 사용자2의 영향으로 바뀐 데이터 조회
: 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.
캐시가능
응답 결과 리소스를 캐시해서 사용해도 되는가?
ex) GET, POST, PATCH 캐시 가능
-> 사실 POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않다. 실제로는 GET 정도만 캐시로 사용한다.