🌎 URI 설계
ex)
회원 목록 조회
회원 조회
회원 등록
회원 수정
회원 삭제
<잘못된 설계>
회원 목록 조회 /read-member-list
회원 조회 /read-member-by-id
회원 등록 /create-member
회원 수정 /update-member
회원 삭제 /delete-member
리소스를 식별해야한다!
->미네랄을 캐다(미네랄이 리소스) 즉 위 예시에서는 회원이 리소스이다.
<조금 개선한 설계>
회원 목록 조회 /members
회원 조회 /members/{id}
회원 등록 /members/{id}
회원 수정 /members/{id}
회원 삭제 /members/{id}
조회,등록,수정,삭제가 구분이 안가는데 어떻게 해야하지??->메소드를 활용한다.
보통 리소스는 명사, 행위는 동사로 한다.
🌎 GET
- 리소스 조회
- query를 통해 데이터를 서버에 전달
- 메시지 바디에 데이터를 담아 전달 할 수 있지만 지원 안하는 곳이 많아 권장하지 않음.
🌎 POST
- 요청 데이터 처리
- 메시지 바디를 통해 서버에 데이터 전달
- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
- 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
** 요청 데이터를 처리한다는게 무슨 의미일까?
ex)
- HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공(HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용)
- 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시(게시판 글쓰기, 댓글 달기)
- 서버가 아직 식별하지 않은 새 리소스 생성(신규 주문 생성)
- 기존 자원에 데이터 추가(한 문서 끝에 내용 추가하기)
이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함 -> 정해진 것이 없음
- 새 리소스 생성(등록)
- 서버가 아직 식별하지 않은 새 리소스 생성
- 요청 데이터 처리
- 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
ex) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우 POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
ex) POST /orders/{orderId}/start-delivery (컨트롤 URI)
- 다른 메서드로 처리하기 애매한 경우
- ex) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우 애매하면 POST
🌎 PUT
- 리소스를 완전 대체
- 리소스 있으면 대체 없으면 생성
ex) 파일있으면 복붙, 없으면 생성 같은 느낌
만약 username:dy,age:50에 대한 데이터가 있을때 age:30으로 변경을 하여 age에 대한 값만 PUT을 사용해 전달을 하면 username:dy,age:30이 아닌 age:30만있게된다.
🌎 PATCH
- 그래서 부분적인 데이터만 변경 할 수 있음
🌎 HTTP 메서드의 속성
안전
- 호출해도 리소스를 변경하지 않는다.
- 계속하면 로그가 쌓이는데 안전하지 않은거 아닙니까?-> 해당 리소스만 고려하므로 그런부분까지 고려하지않는다.
멱등
- 계속 호출해도 데이터가 변하지 않는다.
- GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다. DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
POST: 멱등이 아니다. ex) 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다. - 만약 서버가 자동으로 데이터를 삭제했는데 제대로 삭제되었는지 확인 차 다시 삭제 가능. 하지만 결제를 2번을 하면 안되는것처럼 POST는 멱등이 아니다.
- 만약 GET메소드를 계속 호출했는데 누가 PUT으로 데이터를 변경을해서 다시 GET메소드를 호출하면 다른 데이터가 나온다. 이런 외부적인 요인으로 인해 데이터가 변경되는것은 고려하지 않는다.
캐시
- 만약 용량이 큰 이미지를 다운 받았는데 다시 다운 받을 필요없고 웹브라우저에 내장된 캐시를 이용해서 이미지를 이용 할 수 있다.
- GET, HEAD, POST, PATCH 캐시가능 실제로는 GET, HEAD 정도만 캐시로 사용
- POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않다.
**참고 자료) 김영한님의 강의자료
Back-End