💡 API URI 설계
- 리소스와 행위를 분리해야 한다.
- 가장 중요한 것은 리소스를 식별하는 것!
- 리소스는 명사, 행위는 동사
💡 HTTP 메서드
GET: 리소스 조회POST: 요청 데이터 처리(주로 등록)PUT: 리소스를 대체, 해당 리소스가 없으면 생성PATCH: 리소스 부분 변경DELETE: 리소스 삭제
기타 메서드
HEAD: GET과 동일하지만 메시지 부분을 제외하고 상태 줄과 헤더만 반환OPTIONS: 대상 리소스에 대한 통신 가능 옵션을 설명- 주로 CORS에서 사용
CONNECT: 대상 자원으로 식별되는 서버에 대한 터널 설정TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트 수행
🎈 GET
- 리소스 조회
- 서버에 전달하고 싶은 데이터는 query통해 전달
- 메시지 바디를 사용해서 데이터 전달할 수 있지만, 지원하지 않는 곳이 많아 권장하지 않음
🎈 POST
- 요청 데이터 처리
- 단순히 데이터를 생성하거 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우(ex. 배달 시작 버튼 눌렀을 때)
- 메시지 바디를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리
- 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능 수행
- 주로 신규 리소스 등록, 프로세스 처리에 사용
- 다른 메서드로 처리하기 애매한 경우
- 예)JSON으로 조회 데이터를 넘겨야 하는데, GET메서드를 사용하기 어려운 경우
- 예)JSON으로 조회 데이터를 넘겨야 하는데, GET메서드를 사용하기 어려운 경우
🎈 PUT
- 리소스 대체
- 리소스가 있으면 대체, 없으면 생성 ---> 덮어버림
- 리소스를 완전히 대체하기 때문에 input값 중 하나를 빠뜨리면 빠뜨린 필드가 사라짐
- 클라이언트가 리소스를 식별
- 클라이언트가 리소스 위치를 알고 URI지정 ---> POST와의 차이
(ex. PUT/members/100)
- 클라이언트가 리소스 위치를 알고 URI지정 ---> POST와의 차이
🎈 PATCH
- 리소스 부분 변경
- PUT과 다르게 리소스를 부분적으로만 변경하고 싶을 때
- HTTP에서 PATCH 허용이 안된다면 POST쓰면 된다.
🎈 DELETE
- 리소스 제거
💡 HTTP 메서드의 속성
- 안전
- 멱등
- 캐시 가능
안전
호출해도 리소스를 변경하지 않는다.
멱등
몇 번을 호출하든 결과가 똑같다.
GET: 몇 번을 호출하든 같은 결과가 조회된다.PUT: 결과를 대체한다. 같은 데이터를 가지고 계속 요청을 하면 최종 결과는 같다.DELETE: 결과를 삭제한다. 몇번을 호출하든 최종적으로든 삭제가 되어있기 때문에 삭제된 결과는 같다.POST는 멱등하지 않다. 예를 들어 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.- 멱등의 활용 : 자동 복구 메커니즘
- 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.
캐시가능
- 캐시 : 웹 브라우저 내부에 저장해두는것
- 응답 결과 리소스를 캐시해서 사용해도 되는가?
예를 들어, 웹 브라우저에 이미지가 큰 것을 요청할 때 캐시하면 그 다음에 또 요청할 필요 없음 - GET, HEAD, POST, PATCH 캐시 가능하지만 실제로는
GET,HEAD정도만 캐시로 사용하고POST,PATCH는 본문 내용까지 캐시 키로 고려해야하는데 구현이 쉽지 않으므로 거의 사용하지 않음.
