HTTP API URI 설계
- 설계시 가장 중요한 것은 리소스를 식별 하는 것
그렇다면 리소스란?🙄
- 게시판에 게시글 작성, 게시글 조회, 게시글 삭제, 게시글 수정으로 예를 들자면
- 게시판이라는 개념 자체가 리소스가 되고 게시글 작성, 조회 삭제, 수정은 행위로 구분된다.
- 게시판이라는 리소스를 URI에 매핑하면 된다.
- ex :
- 전체 게시글 조회 /boards
- 게시글 작성 /board
- 게시글 조회 /board/{id}
- 게시글 수정 /board/{id}
- 게시글 삭제 /board/{id}
위와 같이 설계 했을 때 구분을 어떻게 하느냐? 바로 HTTP Method를 통해서 구분할 수 있다.
HTTP Method
- HTTP의 주요 method
- GET : 리소스를 조회
- POST : 요청 데이터 처리, 주로 리소스 생성에 많이 사용
- PUT : 리소스를 대체 하거나 리소스가 없을 경우 새로 생성
- PATCH : 존재하는 리소스의 일부분을 변경
- DELETE : 존재하는 리소스를 삭제
- 기타 method
- HEAD : GET과 동일하지만 메시지 부분을 제외한 상태줄과 헤더만 반환
- OPTIONS : 대상 리소스에 대한 통신 가능 method를 설명(CORS에서 사용)
- CONNECT : 대상 자원으로 식별되는 서버에 대한 터널을 설정
- TRACE : 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트 수행
GET
- 리소스 조회
- 서버에 데이터를 전달할 때에는 query(쿼리 파라미터, 쿼리 스트링)를 통해 전달
- 메시지 바디를 사용해 데이터를 전달할 수 있지만 지원하지 않는 곳들이 많음
POST
- 클라이언트가 메시지 바디를 통해 서버로 요청 데이터를 전달, 서버는 전달 받은 데이터를 처리함
- 새 리소스를 생성 (서버가 아직 식별하지 않은 새 리소스 생성)
- 프로세스를 처리해야 할 경우
- 주문의 경우 결제완료 -> 배달 시작 -> 배달 완료 처럼 프로세스의 상태가 변경될 때에는 새로운 리소스가 생성되지 않을 수 있음
- POST /orders/{orderId}/start-delivery (컨트롤 URI)
- 다른 메서드로 처리하기 애매한 경우 ex :
JSON으로 데이터를 넘겨야 하는데 GET을 사용하기 어려울 경우
PUT
- 리소스를 대체
- 기존 리소스가 있다면 완전히 대체 (기존에 있던 필드가 지워질 수 있음, 기존 리소스를 삭제하고 새로 생성)
- 기존 리소스가 없다면 생성
- 클라이언트가 리소스의 정확한 위치를 알고 URI를 지정 POST와의 차이점
PATCH
- 리소스를 대체하거나 생성하는게 아닌 일부분을 변경
DELETE
HTTP Method의 속성
- 안전
- 몇번을 호출 하든 리소스를 변경하지 않음
- 해당 리소스만 고려하고, 로그가 쌓여서 장애가 발생하는건 고려하지 않음
- 멱등
- 몇번을 호출 하든 결과가 똑같음
- 서버가 정상 응답을 하지 못했을 경우, 클라이언트가 같을 요청을 다시 시도해도 되는지에 대한 판단 근거가 됨
- 외부 요인으로 중간에 리소스가 변경되는 것은 고려하지 않음
- 자동 복구 메커니즘으로 활용
- 캐시 가능
- 응답 결과 리소스를 캐시해서 사용
- 실제로는 GET, HEAD를 캐시로 사용(POST, PATCH는 본문 내용까지 캐시 키로 고려해야해서 구현이 쉽지 않음)
HTTP Method 속성 이미지 출처 : 위키백과