HTTP 메서드
김영한의 HTTP강의 정리 내용입니다.
모든 개발자를 위한 HTTP 웹 기본 지식
HTTP API 구현
요구사항
회원 정보 관리 API를 만들어라.
- 회원 목록 조회
- 회원 조회
- 회원 등록
- 회원 수정
- 회원 삭제
API URI 설계
URI(Uniform Resource Identifier)
- 회원 목록 조회 /read-member-list
- 회원 조회 /read-member-by-id
- 회원 등록 /create-number
- 회원 수정 /update-number
- 회원 삭제 /delete-member
이것은 좋은 URI 설계일까? 가장 중요한 것은 리소스 식별이다. 이것을 기준으로 설계해야 한다.
리소스의 의미는 뭘까?
- 회원을 등록하고 수정하고 조회하는게 리소스가 아니다.
- 예) 미네랄을 캐라 → 미네랄이 리소스
- 회원이라는 개념 자체가 바로 리소스다.
리소스를 어떻게 식별하는게 좋을까?
- 회원을 등록하고 수정하고 조회하는 것을 모두 배제한다.
- 회원이라는 리소스만 식별하면 된다. → 회원 리소스를 URI에 매핑한다.
API URI 설계
다시 설계해보자. 리소스 식별, URI 계층 구조를 활용해보자.
- 회원 목록 조회 /members
- 회원 조회 /members/{id}
- 회원 등록 /members/{id}
- 회원 수정 /members/{id}
- 회원 삭제 /members/{id}
리소스 만을 가지고 구분이 되지 않는 문제가 발생한다. 그래서 리소스와 행위를 분리해야 한다.
리소스와 행위를 분리
가장 중요한 것은 리소스를 식별하는 것이다.
- URI는 리소스만 식별한다.
- 리소스와 해당 리소스를 대상으로 하는 행위를 분리한다.
- 리소스: 회원
- 행위: 조회, 등록, 삭제, 변경
- 리소스는 명사, 행위는 동사가 된다.
- 행위(메서드)는 어떻게 구분하는가? 바로 HTTP 메서드가 이 역할을 대신한다.
HTTP 메서드
주요 메서드
- GET: 리소스 조회
- POST: 요청 데이터 처리, 주로 등록에 사용
- PUT: 리소스를 대체, 해당 리소스가 없으면 생성
- PATCH: 리소스 부분 변경
- DELETE: 리소스 삭제
기타 메서드
- HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
- OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
- CONNECT: 대상 자원으로 식별되는 서버에 대한 터널을 설정
- TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
GET
- 리소스를 조회한다.
- 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달한다.
- 메시지 바디를 사용해서 데이터를 전달할 순 있지만, 지원하지 않는 곳이 많아서 권장하지 않는다.
POST
- 요청 데이터를 처리한다.
- 메시지 바디를 통해 서버로 요청 데이터를 전달한다.
- 서버는 요청 데이터를 처리한다.
- 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용한다.
요청 데이터를 어떻게 처리한다는 뜻일까? 예시
- 스펙: POST 메서드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함 된 표현을 처리하도록 요청한다.
- POST는 예를 들어 다음과 같은 기능에 사용된다.
- HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공한다.
- 예시) HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용한다.
- 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지를 게시한다.
- 예시) 게시판 글쓰기, 댓글 달기
- 서버가 아직 식별하지 않은 새 리소스를 생성한다.
- 예시) 신규 주문 생성
- 기존 자원에 데이터를 추가한다.
- 예시) 한 문서 끝에 내용 추가하기.
- HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공한다.
- 정리: 이 리소스 URI에 POST요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 한다. → 정해진 것이 없다.
정리
- 새 리소스 생성(등록)
- 서버가 아직 식별하지 않은 새 리소스를 생성한다.
- 요청 데이터 처리
- 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우.
- 예시) 주문에서 결제완료 → 배달시작 → 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우.
- POST의 결과로 새로운 리소스가 생성되지 않을 수도 있다.
- “미네랄을 캐라”에서 행위인 “캐라”를 분리하는 것이 이상적 이지만 항상 그럴 수는 없다. 최대한 리소스로 URI를 설계하되 어쩔 수 없을 때는 컨트롤 URI로 설계한다. 컨트롤 URI란 동사의 URI를 말한다.
- 예시) POST /orders/{orderId}/start-delivery (컨트롤 URI)
- 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우.
- 다른 메서드로 처리하기 애매한 경우
- 예시) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우.
GET 메서드에서 메시지 바디로 데이터를 전달할 순 있지만 지원하지 않는 서버들이 많다. 보통 GET에서 메시지 바디를 잘 허용하지 않는다. 이럴 땐 조회지만 POST를 써야한다. - 애매하면 POST
POST는 모든 것을 할 수 있다. 하지만 조회할 땐 GET을 쓰는 것이 유리하다. 서버끼리 GET으로 왔을 때 캐싱을 하겠다는 약속을 했을 때 POST로 오면 어렵게 된다.
- 예시) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우.
PUT
- 리소스를 대체한다.
- 리소스가 있으면 대체한다.
- 리소스가 없으면 생성한다.
- 다른 말로 덮어버린다(삭제하고 새로 생성한다)는 말이다.
- 중요! 클라이언트가 리소스를 식별한다.
- 클라이언트가 리소스 전체 위치를 알고 URI를 지정하는 것이다.
- POST와 차이점
POST는 /members 에다가 보내면 100번에 만들어질지 200번에 만들어질지 모르지만 PUT은 /members/100 이렇게 100번에다가 집어넣겠다고 정확하게 지정한다. 그래서 PUT은 클라이언트가 리소스를 식별한다.(리소스를 알고있다.)
- 주의: 리소스를 완전히 대체한다.
리소스를 수정하기 어렵다. 기존의 리소스를 완전히 삭제하고 새로운 리소스를 생성하는 것이다. PUT은 리소스를 수정하는 것이 아니라 완전히 갈아 치우는 것이다. 수정을 하고 싶다면 PATCH를 사용한다.
PATCH
리소스를 부분 변경한다. 혹시 PATCH가 지원이 안되는 서버가 있다면 POST를 사용하면 된다.
DELETE
리소스를 제거한다.
HTTP 메서드의 속성
GET같은 경우에 요청에 Body를 넣을 순 있지만 사용하지 않는 것이 좋다.
안전(Safe)
- 호출해도 리소스를 변경하지 않는다.
- GET은 조회만 하니 안전하다. POST, DELETE, PUT, PATCH… 이렇게 호출했을 때 변경이 일어나면 안전하지 않다.
- Q: 만약 계속 호출해서 로그 같은 것이 쌓여서 장애가 발생한다면?
A: 안전은 해당 리소스만 고려한다. 그런 부분까지 고려하지 않는다.
멱등(Idempotent)
- f(f(x)) = f(x)
- 한 번 호출하든 두 번 호출하든 백 번 호출하든 결과가 똑같다.
- 멱등 메서드
- GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
- PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
- DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
- POST: 멱등이 아니다. 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
- 활용
- 자동 복구 메커니즘
- 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가? 판단 근거
DELETE를 호출하고 서버에서 응답이 없어 잘됐는지 안됐는지 알 수 없을 때 클라이언트가 자동으로 다시 DELETE를 재시도해도 멱등하기 때문에 상관없다. 그래서 자동 복구 메커니즘에 사용할 수 있다.
- Q: 재요청 중간에 다른 곳에서 리소스를 변경해 버린다면?
- 사용자1: GET → username:A, age:20
- 사용자2: PUT → username:A, age:30
- 사용자3: GET → username:A, age:30
→ 사용자2의 영향으로 바뀐 데이터가 조회된다.
A: 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.
캐시가능(Cacheable)
- 응답 결과 리소스를 캐시해서 사용해도 되는가?
- GET, HEAD, POST, PATCH 캐시가능
- 실제로는 GET, HEAD 정도만 캐시로 사용
- POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않다.
- GET은 URL만 키로 잡고 캐시를 하면 돼서 간단하다.
Leave a comment