HTTP API 설계!
요구사항
회원정보관리 API만들어라
회원 목록조회
회원 조회
회원 등록
회원 수정
회원 삭제
API URI 설계(Uniform Resource Identifier)
회원 목록조회( read-member-list)
회원 조회(read-member-by-id)
회원 등록(create-member)
회원 수정(update-member)
회원 삭제(delete-member)
가장 중요한것 -> 리소스 식별!
API URI 고민
리소스의 의미?
리소스를 어떻게 식별하는게 좋을까?
API URI 설계
리소스식별 , URI 계층 구조 활용
회원 목록조회 /members
회원 조회 /members/{id} -> 어떻게 구분하지?
회원 등록 /members/{id} -> 어떻게 구분하지?
회원 수정 /members/{id} -> 어떻게 구분하지?
회원 삭제 /members/{id} -> 어떻게 구분하지?
URI는 리소스만 식별!
리소스와 해당 리소스를 대상으로 하는 행위를 분리
리소스 : 회
행위 : 조회 , 등록 , 삭제 , 변경
리소스 : 명사 , 행위 : 동사
행위(메소드)는 어떻게 구분?
HTTP 메소드 - GET , POST
GET
리소스 조회
서버에 전달하고 싶은 데이터는 query(쿼리파라미터 , 쿼리스트링)을 통해서 전달
메시지 바디를 사용해서 데이터를 전달 할 수 있지만 지원하지 않는 곳이 많아서 권장하지 않음
POST
요청 데이터 처리 , 주로 등록에 사용
메시지 바디를 통해 서버로 요청 데이터 전달
서버는 요청 데이터를 처리
- 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
주로 전달된 데이터를 가지고 신규 리소스 등록, 프로세스 처리에 사용
대상리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청
정리 : 이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함!
-> 정해진 것이 없다
1. 새 리소스 생성(등록)
서버가 아직 식별하지 않은 새 리소스 생성
2. 요청 데이터 처리
단순히 데이터를 생성하거나 , 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
ex) 주문에서 결제완료-> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
ex) POST/orders/{orderid}/start-delivery 컨트롤 URI
3. 다른 메소드로 처리하기 애매한 경우
ex) JSON으로 조회 데이터를 넘겨야 하는데 , GET 메소드를 사용하기 어려운 경우
애매하면 PSOT
조회 데이터는 가능하면 GET으로 처리한다!
PUT
**리소스를 완전히 대체 한다 , 해당리소스가 없으면 생성
덮어버린다!(overite)
클라이언트가 리소스를 식별!
클라이언트가 리소스 위치를 알고 URI 지정(POST와의 차이점)
리소스 수정이 불가 -> 완전히 갈아 치운다
PATCH
리소스 부분 변경
patch를 지원하지 않는 브라우저도 존재 -> POST를 사용한다(all mighty)
DELETE
리소스 삭제
기타메소드
HEAD : get과 동일하지만 메시지부분 제외하고 상태/헤더만 반환
OPTIONS
CONNECT
TRACE
HTTP 메소드의 속성
안전 Safe
호출해도 리소스를 변경하지 않는다.
Q : 계속된 호출로 로그같은게 쌓여서 장애 발생시?
A : 안전은 해당 리소스만 고려하기때문에 그런 부분까지는 고려하지 않음
멱등 Idempotent
f(f(x)) = f(x)
한번 호출하던 , 두번 호출하던 100번 호출하던 결과는 똑같다
멱등메소드
GET
PUT
DELETE
POST : 멱등이 아니다! 두번 호출하면 같은결제가 중복해서 발생 가능!
활용
자동 복구 메커니즘
서버가 TIMEOUT 등으로 정상 응답을 못 주었을때 , 클라이언트가 같은 요청을 다시 해도 되는가? 판단근거
Q : 재요청 중간에 다른 곳에서 리소스를 변경시?
사용자 1 : GET
사용자 2 : PUT
사용자 1 : GET
A : 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지 고려하지는 않는다.
캐시가능 Cacheable
응답 결과 리소스를 캐시해서 사용해도 되는가?
GET , HEAD , POST , PATCH 캐시가능
실제로는 GET , HEAD 정도만 캐시로 사용
POST , PATCH는 본문내용까지 캐시키로 고려해야 하는데 , 구현이 쉽지 않
