HTTP API 설계
API URI는 리소스가 핵심
CRUD는 리소스가 아님
**
회원이라는 개념 자체가 리소스
Ex) 게시판, 댓글, 상품 등등
리소스 식별
등록, 수정, 삭제, 조회하는 것을 모두 배제
회원이라는 리소스만 식별하면 됨
**
회원 리소스를 URI에 매핑
API URI 설계
1. 리소스 식별 (가장 중요)
2. URI 계층 구조 활용
- 상위를 컬렉션으로 보고 복수 단어 사용 할 것 members
**** 리소스와 행위를 분리
행위는 HTTP 메서드로 표현
Get, Post, Put, Update, Delete 등등
** 즉 URI는 리소스만 식별하면 된다.
HTTP 메서드
클라이언트가 서버에 요청할 때 필요한 행위
조회, 등록, 수정, 삭제
GET - 리소스 조회
POST - 요청 데이터 처리, 주로 등록에 사용
PUT - 리소스를 대체, 해당 리소스가 없으면 생성
PATCH - 리소스 부분 변경
DELETE - 리소스 삭제
기타 HTTP 메서드
HEAD - GET과 동일하지만 메시지 부분을 제외하고 상태 줄과 헤더만 반환 (BODY 제외하고 보냄)
OPTIONS - 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
CONNECT - 대상 자원으로 식별되는 서버에 대한 터널을 설정
TRACE - 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
GET 메서드
리소스 조회 ( 특정 데이터를 줘 )
서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달
메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장 X
1. 메시지 서버로 전달
2. 메시지 서버에 도착
3. 클라이언트로 응답 데이터 전송
POST 메서드
요청 데이터 처리 (데이터를 줄테니 서버가 요청 데이터를 처리해줘 )
메시지 바디를 통해 서버로 요청 데이터 전달
서버는 요청 데이터를 처리 (메시지 바디를 들어온 데이터를 처리하는 모든 기능을 수행)
주로 신규 리소스 등록, 프로세스 처리에 사용
1. 새 리소스 생성(등록)
2. 요청 데이터 처리
- 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야하는 경우
결제완료 -> 배달시작 -> 배달완료
즉, POST 결과로 새로운 리소스가 생성되지 않을 수 있음
POST /orders/{orderId}/start-delivery(컨트롤 URI)
- URI에 동사를 넣어서 컨트롤 URI를 만들 수 있다. (어쩔 수 없는 경우 사용)
3. 다른 메서드로 처리하기 애매한 경우
-JSON으로 조회 데이터를 넘겨야하는데, GET 메서드를 사용하기 어려운 경우
**
POST 요청은 요청 데이터를 어떻게 처리할지 정해진 것이 없기 때문에
리소스마다 어떻게 처리할지 따로 정해야 함
1. 메시지 서버로 전달
2. 서버는 메시지를 받아 신규 리소스 생성
3. 클라이언트로 응답 데이터 전송
201로 응답하는 경우 Location:/members/100은 생성된 신규 리소스 경로를 보내줌