HTTP API 설계❓
좋은 API URI 설계의 가장 중요한 것은 리소스 식별이다.
리소스라는 것은 어떤 행위를 말하는 것이 아니라, 그 행위의 주체/대상이 리소스가된다.
예를 들어 회원 등록, 회원 삭제가 리소스가 아니라 회원이라는 개념 자체가 리소스이다.
API 설계 시 리소스와 행위를 분리하고, 리소스를 식별하는 것이 가장 중요하다👍
HTTP 메서드❓
HTTP의 주요 메서드는 5가지 정도 된다.
- GET : 리소스 조회
- POST : 요청 데이터 처리, 주로 등록에 사용
- PUT : 리소스를 대체, 해당 리소스가 없으면 새로 생성
- PATCH : 리소스 수정(부분 변경)
- DELETE : 리소스 삭제
GET❓
이름에서 알 수 있듯이 리소스를 조회하는 데 사용한다.
서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)을 통해서 전달한다.
ex) /search?q=hello&hl=ko
POST❓
주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용한다.
메시지 바디를 통해 서버로 요청 데이터를 전달해서 처리해 달라고 하는 것이다.
POST를 단순 신규 등록을 할 때 쓰이는 것으로 많이 알고 있지만, 어떤 프로세스를 처리할 때도 POST를 쓴다👍
사실 POST는 만능이다😱 GET의 기능을 충분히 POST로도 할 수 있다. 하지만 캐싱 같은 이유로 단순 조회라면 GET을 쓰는 게 좋다❗
PUT❓
리소스를 대체하는 데 사용한다.
리소스가 있으면 완전히 대체를 하고, 리소스가 없으면 생성한다❗ 덮어버린다고 생각하면 된다.
클라이언트가 리소스의 위치를 알고 URI를 지정해줘야 한다❗
PATCH❓
리소스를 부분 변경하는 데 사용한다.
말 그대로 존재하는 리소스에 부분만 변경한다.
PUT과 마찬가지로 클라이언트가 리소스의 위치를 알고 있어야 한다❗
DELETE❓
리소스를 제거한다.
말 그대로 리소스를 제거하는 것이다.
HTTP 메서드의 속성❓
- 안전(Safe Methods) - 호출해도 리소스를 변경하지 않는다.
- 멱등(Idempotent Methods) - 몇 번을 호출하더라도 결과는 항상 같아야 한다. (외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.)
GET - 몇번을 조회해도 항상 같은 결과가 조회된다.
PUT - 결과를 대체하기 때문에 같은 요청을 여러 번 해도 최종 결과는 똑같다.
DELETE - 결과를 삭제하기 때문에 같은 요청을 여러번해도 삭제된 결과는 똑같다.
POST - 멱등이 아니다😱 여러 번 호출하면 그만큼 결과도 여러 개 생길 수 있기 때문에 중복이 발생한다. - 캐시가능(Cacheable Methods) - GET, HEAD 정도만 캐시로 사용한다.
( GET은 URL만 키로 잡고 캐싱을 하면 되는데, POST, PATCH는 바디안의 내용까지 캐시 키로 고려해야 하므로 구현이 쉽지 않다 )
출처
https://www.inflearn.com/course/http-%EC%9B%B9-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC
'네트워크' 카테고리의 다른 글
HTTP 웹 기본 지식 - HTTP 헤더(일반 헤더) (0) | 2021.09.16 |
---|---|
HTTP 웹 기본 지식 - HTTP 상태코드 (0) | 2021.09.04 |
HTTP 웹 기본 지식 - HTTP 기본 (0) | 2021.08.27 |
HTTP 웹 기본 지식 - URI와 웹 브라우저 요청 흐름 (0) | 2021.08.24 |
HTTP 웹 기본 지식 - 인터넷 네트워크 (0) | 2021.08.24 |