📌HTTP API
API URI 설계
회원 정보 관리 API를 만들 때, 요구사항은 다음과 같을 때, API의 URI를 어떻게 설정해야할까?
• 회원 목록 조회
• 회원 조회
• 회원 등록
• 회원 수정
• 회원 삭제
이때, 가장 중요한 것은 리소스 식별
- 리소스란?
회원을 등록, 수정, 조회하는게 (행위) 리소스가 아니고 회원이라는 개념 자체가 리소스이다.
• 회원 목록 조회 /members
• 회원 조회 /members/{id}
• 회원 등록 /members/{id}
• 회원 수정 /members/{id}
• 회원 삭제 /members/{id}
참고: 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장(member -> members)
URI는 리소스만 식별하고, 리소스와 해당 리소스를 대상으로 하는 행위를 분리한다.
->회원 조회할 때 /read-member-id 이런식으로 하면 안됨🙅♀️
그런데 이렇게 uri를 설계하면 행위는 어떻게 구분해야할까?
📌HTTP 메서드
GET: 리소스 조회
서버에 전달하고 싶은 데이터는 쿼리를 통해 전달한다.
GET /search?q=hello&hl=ko HTTP/1.1
HOST:www.google.com
POST: 요청 데이터 처리, 주로 등록에 사용
메시지 바디를 통해 서버로 요청데이터를 전달 => 서버는 요청데이터를 처리
이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함 -> 정해진 것이 없음
POST /members HTTP/1.1
Content-Type: application/json
{
"username": "hello",
"age": 20
}
- POST 정리
- 새 리소스 생성할 때(등록)
• 서버가 아직 식별하지 않은 새 리소스 생성 - 요청 데이터 처리
• 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
• 예) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
• POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
• 예) POST /orders/{orderId}/start-delivery (컨트롤 URI) - 다른 메서드로 처리하기 애매한 경우
• 예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
• 애매하면 POST
PUT: 리소스를 대체, 해당 리소스가 없으면 생성
클라이언트가 리소스를 식별(클라이언트가 리소스 위치를 알고, URI 지정-POST와 차이점)
PUT /members/100 HTTP/1.1
Content-Type: application/json
{
"username": "hello",
"age": 20
}
PATCH: 리소스 부분 변경
DELETE: 리소스 삭제
📌HTTP 메서드의 속성
-
안전(Safe Methods)
호출해도 리소스를 변경하지 않는다. -
멱등(Idempotent Methods)
f(f(x)) = f(x) 한번 호출하든 100번 호출하든 결과가 같다.
POST는 멱등이 아님!-두번 호출하면 중복거래 발생 위험
-멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지는 않는다.
-PATCH도 멱등 아님 -
캐시가능(Cacheable Methods)
• 응답 결과 리소스를 캐시해서 사용해도 되는가?
• GET, HEAD, POST, PATCH 캐시가능
• 실제로는 GET, HEAD 정도만 캐시로 사용
• POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않음
