- HTTP API를 만들자
- HTTP 메서드 - GET, POST
- HTTP 메서드 - PUT, PATCH, DELETE
- HTTP 메서드 속성
- 회원 목록 조회 /read-member-list -> /members
- 회원 조회 /read-member-by-id -> /members/{id}
- 회원 등록 /create-member -> /members/{id}
- 회원 수정 /update-member -> /members/{id}
- 회원 삭제 /delete-member -> /members/{id}
URI는 리소스만 식별!
리소스와 해당 리소스를 대상으로 하는 행위를 분리
- 리소스 : 회원
- 행위 : 조회, 등록, 삭제, 변경
리소스는 명서, 행위는 동사
행위(메서드)는 어떻게 구분할 것인가?
- GET : 리소스 조회
- POST : 요청 데이터 처리, 주로 등록에 사용
- PUT : 리소스를 대체, 해당 리소스가 없으면 생성
- PATCH : 리소스 부분 변경
- DELETE : 리소스 삭제
- 리소스 조회
- 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터)를 통해서 전달
- 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음.
순서
- 리소스 조회1 - 메시지 전달
- 리소스 조회2 - 서버 도착
- 리소스 조회3 - 응답 데이터
- 요청 데이터 처리
- 메시지 바디를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리
- 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
순서
- 리소스 등록1 - 메시지 전달
- 리소스 등록2 - 신규 리소스 생성
- 리소스 등록3 - 응답 데이터
POST 정리
1. 새 리소스 생성(등록)
- 서버가 아직 식별하지 않은 새 리소스 생성
2. 요청 데이터 처리
- 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
- ex) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단수히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
- POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음.
- ex) POST/orders/{orderId}/start-delivery (컨트롤 URI)
3. 다른 메서드로 처리하기 애매한 경우
- ex) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
- 애매하면 POST
리소스를 대체
- 리소스가 있으면 대체
- 리소스가 없으면 생성
- 쉽게 비유한다면 "덮어쓰기"
★ 클라이언트가 리소스를 식별
- 클라이언트가 리소스 위치를 알고 직접 URI 지정 (POST와 차이점)
- 리소스가 있는 경우1
- 리소스가 있는 경우2
- 리소스가 없는 경우1
- 주의) 리소스를 완전히 대체한다1
- 주의) 리소스를 완전히 대체한다2
- 리소스 부분 변경1
- 리소스 부분 변경2
+ PATCH가 지원안될 때는 POST 사용
- 리소스 제거1
- 리소스 제거 2
- 여러번 호출해도 리소스를 변경하지 않는다.
- f(f(x)) = f(x)
- 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.
- 멱등 메서드
- GET : 한 번 조회하든, 두 번 조회하든 같은 결과 조회.
- PUT : 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 똑같다.
- DELETE : 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
- POST : 멱등이 아니다!! 두 번 이상 호출하면 같은 결제가 중복해서 발생할 수 있다.
- 응답 결과 리소스를 캐시해서 사용해도 되는가?
- GET, HEAD, POST, PATCH 캐시가능
- 실제로는 GET, HEAD 정도만 캐시로 사용
- POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않음.