이 글은 김영한님 ‘모든 개발자를 위한 HTTP 웹 기본 지식’ 강의를 듣고 작성합니다.
[4. http 메서드] 강의에 해당된 내용을 정리하며 회고록을 작성합니다.
https://www.inflearn.com/course/http-웹-네트워크
좋은 HTTP API 설계
HTTP API를 설계할 때 고려해야 할 가장 중요한 것은 리소스 식별! 이다.
리소스의 의미는 뭘까?
다음과 같은 회원 정보를 관리하는 API를 만든다고 가정해보자
- 회원 목록 조회
- 회원 조회
- 회원 등록
- 회원 수정
- 회원 삭제
API URI 설계
- 회원 목록 조회 /read-member-list
- 회원 조회 /read-member-by-id
- 회원 등록 /create-member
- 회원 수정 /update-member
- 회원 삭제 /delete-member
이렇게 설계를 할 것인가!
API를 설계할 때, 2가지를 고려해야한다.
- 리소스의 의미는 뭘까?
여기에서 리소스는 회원을 등록하고 수정하고 조회하는게 아니다!
"미네랄을 캐라" 에서 리소스는 "미네랄"이다.
즉, "회원"이라는 개념 자체가 바로 리소스다.
- 리소스를 어떻게 식별하는게 좋을까?
회원을 등록하고 수정하고 조회하는 것을 모두 배제하고 회원이라는 리소스만 식별하면 된다.
즉, 회원 리소스를 URI에 매핑!
좋은 API URI 설계
- 회원 목록 조회 /members
- 회원 조회 /members/{id}
- 회원 등록 /members/{id}
- 회원 수정 /members/{id}
- 회원 삭제 /members/{id}
계층 구조상 상위 컬렉션으로 보고 복수 단어 사용을 권장한다. (member->members)
하지만 회원 조회, 등록, 수정, 삭제가 같은 URI로 되어 있는데, 어떻게 구별하지?라는 의문이 들 수 있다.
리소스와 행위를 분리
URI는 리소스만 식별한다. 리소스와 해당 리소스를 대상으로 하는 행위를 분리하는데,
- 리소스: 회원
- 행위 : 조회, 등록, 삭제, 변경
이런 식으로, 리소스는 명사, 행위는 동사로 구분한다.
하지만, 행위는 어떻게 구분을 할까??
바로 메소드로 구분을 한다!
HTTP 메서드
주요 메서드 종류
- GET: 리소스 조회
- POST: 요청 데이터 처리, 주로 등록에 사용
- PUT: 리소스를 대체, 해당 리소스가 없으면 생성
- PATCH: 리소스 부분 변경
- DELETE: 리소스 삭제
기타 메서드
- HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
- OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
- CONNECT: 대상 리소스로 식별되는 서버에 대한 터널을 설정
- TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
주요 메서드 하나씩 살펴보자!
HTTP 메서드 - GET
- 리소스 조회
- 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달
- 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음
- 클라이언트는 서버에게 /members/100 URI로 GET 요청을 보낸다.
- 서버는 /members/100에 해당하는 정보를 조회한다.
- 서버는 응답 데이터를 만들어 /members/100에 해당하는 정보를 http body로 함께 보낸다.
HTTP 메서드 - POST
- 요청 데이터 처리
- 메시지 바디를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리
- 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다. - 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
- 클라이언트는 서버에게 /members URI로 username, age 데이터를 담아서 POST요청을 보낸다.
- 서버는 /members/100 에 신규 리소스를 생성한다.
- 신규 리소스 정보를 담은 응답 데이터를 다시 클라이언트에게 보낸다.
POST는 요청 데이터를 처리하는 역할인데, 어떻게 처리한다는 뜻일까?
예시)
- 스펙: POST 메서드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함 된 표현을 처리하도록 요청
POST는 다음과 같은 기능에 사용된다.
- HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
- HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용
- 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
- 게시판 글쓰기, 댓글 달기
- 서버가 아직 식별하지 않은 새 리소스 생성
- 신규 주문 생성
- 기존 자원에 데이터 추가
- 한 문서 끝에 내용 추가하기
정리하자면, 이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야함 → 정해진 것은 없음
POST 정리
- 1. 새 리소스 생성(등록)
- 서버가 아직 식별하지 않은 새 리소스 생성
- 2. 요청 데이터 처리
- 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
- 예) 주문에서 결제 완료 -> 배달 시작-> 배달 완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
- POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
- 예) POST /orders/{orderId}/start-delivery (컨트롤 URI)
- 3. 다른 메서드로 처리하기 애매한 경우
- 예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
- 애매하면 POST !
HTTP 메서드 - PUT
- 리소스를 대체
- 리소스가 있으면 대체
- 리소스가 없으면 생성
- 쉽게 이야기해서 덮어버림
- 중요! 클라이언트가 리소스를 식별
- 클라이언트가 리소스 위치를 알고 URI 지정
- POST와 차이점
- 클라이언트가 서버에게 /members/100에 "age":50 으로 PUT 요청을 보낸다.
- 서버는 /mebers/100에 있는 기존 데이터를 없애고 클라이언트가 보낸 "age":50 으로 값을 변경한다.
HTTP 메서드 - PATCH
- 리소스 부분 변경
- PATCH 지원 안되는 곳도 있다 → 그럴 땐 POST 사용
- 클라이언트가 서버에게 /members/100에 "age":50 으로 PATCH 요청을 보낸다.
- 서버는 /mebers/100에 있는 기존 데이터에서 age 값만 클라이언트가 보낸 "age":50 으로 값을 변경한다.
즉, PUT과 PATCH의 차이점은 데이터 전체를 수정하느냐, 부분 수정하느냐 차이
PUT 요청이 데이터 전체를 수정, PATCH 요청이 부분 수정
HTTP 메서드 - DELETE
- 리소스 제거
- 클라이언트가 서버에게 /members/100에 DELETE 요청 보낸다.
- 서버는 /members/100에 있는 리소스를 삭제한다.
HTTP 메서드의 속성
- 안전 (Safe Methods)
- 멱등(Idempotent Methods)
- 캐시가능(Cacheable Methods)
Safe 안전
- 호출해도 리소스를 변경하지 않는다.
- 하지만, 계속 호출해서, 로그 같은게 쌓여서 장애가 발생하면 어떡하죠?? → 안전은 해당 리소스만 고려한다. 그런 부분까지 고려하지 않음
Idempotent 멱등
-
f(f(x)) = f(x)
-
한 번 호출하든 두 번 호츨하든 100번 호출하든 결과가 똑같다.
-
멱등 메서드
- GET : 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
- PUT : 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
- PUT은 기존 거를 날리고 내가 보낸걸로 완전히 덮어버린다.
- DELETE : 결과를 삭제한다. 같은 요청을 여러 번 해도 삭제된 결과는 똑같다.
- POST : 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
-
활용
- 자동 복구 메커니즘
- 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가? 판단 근거
- 예시 ) delete를 호출했는데 서버에서 응답을 주지 않아 → client가 한 번 더 delete 호출 → 결과는 똑같이 사라진 것과 같음
멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.
Cacheable 캐시가능
- 응답 경과 리소스를 캐시해서 사용해도 되는가?
- GET, HEAD, POSt, PATCH 캐시 가능
- 실제로는 GET, HEAD 정도만 캐시로 사용
- POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않음
정리
좋은 HTTP API는 리소스를 식별하고, 리소스와 행위를 분리하여 설계한다. 리소스와 행위의 분리는 메소드로 구분한다.
HTTP 메서드 종류는 GET, POST, PUT, PATCH, DELETE가 있다. GET은 리소스를 조회, POST는 요청 데이터를 처리, PUT은 리소스를 대체, PATCH는 리소스를 부분 변경 그리고 DELETE는 리소스를 제거한다.
HTTP 메서드의 속성에는 안전, 멱등, 캐시가능이 있다. 안전은 호출해도 리소스를 변경하지 않는 안전, 멱등은 한 번 호출하든 두 번 호출하든 결과가 똑같다는 의미이다.
