회원 정보 관리 API를 만든다고 가정해보자. 요구사항을 정리하고 API URI를 설계해보면 ?
- 회원 목록 조회 ( /read-member-list )
- 회원 조회 ( /read-member-by-id )
- 회원 등록 ( /create-member )
- 회원 수정 ( /update-member )
- 회원 삭제 ( /delete-member )
이것은 과연 좋은 URI 설계일까 ? 중요한 것은 리소스 식별이다.
리소스(Resource) 의미
리소스의 의미는 뭘까? 만약 회원을 등록한다고 하면, "회원 등록"은 리소스가 아니다.
바로 "회원" 이라는 개념 자체가 리소스인 것이다. 다시 API URI를 설계 해보면 다음과 같이 설계할 수 있다.
- 회원 목록 조회 ( /members )
- 회원 조회 ( /members/{id} )
- 회원 등록 ( /members/{id} )
- 회원 수정 ( /members/{id} )
- 회원 삭제 ( /members{id} )
그렇다면 조회, 등록, 수정, 삭제는 어떻게 구분할 수 있을까 ? 바로 리소스와 행위를 분리하는 것이다.
리소스와 행위의 분리
가장 중요한 것은 리소스를 식별하는 것이다.
- 리소스 : 회원
- 행위 : 조회, 등록, 삭제, 변경
HTTP 메서드
- GET : 리소스 조회
- POST : 요청 데이터 처리, 주로 등록에 사용
- PUT : 리소스를 대체, 해당 리소스가 없으면 생성 (기존 리소스를 덮어버림)
- PATCH : 리소스 부분 변경
- DELETE : 리소스 삭제
- HEAD : GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
- OPTIONS : 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명 (주로 CORS에서 사용)
- CONNECT : 대상 자원으로 식별되는 서버에 대한 터널을 설정
- TRACE : 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
GET
- 리소스 조회
- 서버에 전달하고 싶은 데이터는 query (쿼리 파라미터, 쿼리 스트링)를 통해 전달
- Message body를 사용해 데이터를 전달할 수 있으나, 지원하는 곳이 많지 않아 권장 X
POST
- 요청 데이터 처리
- Message body를 통해 서버로 요청 데이터를 전달
- 서버는 요청 데이터를 처리
- 주로 전달된 데이터로 신규 리소스 등록이나 프로세스 처리에 사용한다.
POST는 클라이언트 측에서 요청을 하게 되면 보통 서버측에서 새 리소스를 생성한다. 위 그림에서 서버측을 살펴보면 /members/100 은 클라이언트 측이 요청한 member를 /members의 100번 리소스에 등록을 하겠다. 라는 의미와 같기 때문에 해당 위치까지 클라이언트에게 반환해주는 것을 볼 수 있다.
POST 요청 데이터를 어떻게 처리한다는 뜻일까 ?
- HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
- 예) HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용
- 게시판, 뉴스 그룹, 블로그 또는 유사한 기사 그룹에 메시지 게시
- 예) 게시판 글쓰기, 댓글 달기
- 서버가 아직 식별하지 않은 새 리소스 생성
- 예) 신규 주문 생성
- 기존 자원에 데이터 추가
- 예) 한 문서 끝에 내용 추가하기
- 정리 : 이 리소스 URI에 POST 요청이 오면 데이터 어떻게 처리할지 리소스마다 따로 정해야 함 (정해진 게 없음)
POST 정리
1. 새 리소스 생성(등록) - 서버가 아직 식별하지 않은 새 리소스 생성
2. 요청 데이터 처리
- 단순히 데이터 생성, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
- 예) 주문에서 결제완료 → 배달시작 → 배달완료 처럼 단순 값 변경을 넘어 프로세스의 상태 변경
- POST의 결과로 새로운 리소스가 생성되지 않을 수도 있다.
- ex) POST /orders/{orderId}/start-delivery (컨트롤 URI)
3. 다른 메서드로 처리하기 애매한 경우
- 예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
- 애매하면 그냥 POST 쓰자 !
PUT
1. 리소스를 대체 ( 덮어버림 )
- 리소스 있으면 대체 ( 기존에 존재하던 필드를 기재하지 않고 PUT을 쓰면 해당 필드는 사라짐, 아예 덮어버림 )
- 리소스 없으면 생성
2. 클라이언트가 리소스를 식별 !
- 클라이언트가 리소스 위치를 알고 URI 지정
- POST와 차이점 (POST는 서버측이 새 리소스를 생성함)
PATCH
- 리소스 부분 변경
PUT은 아예 덮어버린다는 특징이 있다. {"name" : "hello", "age": 20} 이라는 필드가 존재하는데
PUT {"age":20} 으로 요청을 하면 기존의 name 필드는 아예 덮어져버려 사라지게 되는데,
PATCH를 사용하게 되면 PATCH {"age":50} 으로 요청하면 기존의 필드는 유지하면서 존재하는 age의 필드를 수정한다.
DELETE
HTTP 메서드의 속성
- 안전(Safe Methods)
- 멱등(Idempotent Methods)
- 캐시가능(Cacheable Methods)
안전 (Safe Methods)
- 호출해도 리소스를 변경하지 않는다.
- Q : 그래도 계속 호출해서, 로그 같은게 쌓여서 장애가 발생하면 ??
- A : 안전은 해당 리소스만 고려하기 때문에 그런 부분까지 고려하지 않는다.
- 따라서 값을 수정하지 않고 조회하는 GET, HEAD 메소드 정도만 안전을 보장한다.
멱등(Idempotent)
- 한 번 호출하든, 두 번 호출하든 같은 결과가 조회된다.
- 멱등 메서드를 살펴보자.
- GET : 한번 조회하든, 두 번 조회하든 다 같은 결과를 조회한다.
- PUT : 결과를 대체한다. 이 때 "대체한다"에서 의문이 생길 수 있는데 결국 같은 요청을 하면 최종 결과는 같다.
- DELETE : 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
- POST : 멱등이 아니다 !!!! (결제를 두 번 호출하면 두 번 결제가 되기 때문에 중복이 발생할 수 있다.)
캐시가능(Casheable)
- 응답 결과 리소스를 캐시해서 사용해도 되는가 ?
- GET, HEAD, POST, PATCH 캐시 가능
- 실제로는 GET, HEAD 정도만 캐시로 사용
- POST, PATCH는 본문 내용까지 캐시 키로 고려해야 해서 구현이 쉽지 않다.
캐시가능은 만약 어떤 대량의 정보를 GET으로 요청한다고 했을 때 매번 대량 정보를 찾아서 반환해주는 것이 아니라,
저장해놓고 요청이 들어오면 반환해주는 식으로 동작하는 것을 예로 들 수 있다.
참고 자료
https://www.inflearn.com/course/http-%EC%9B%B9-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC/dashboard