HTTP API
HTTP를 사용해서 서로 정해둔 스펙으로 데이터를 주고 받으며 통신하는 것
- REST API: 다음 4가지 제약 조건을 만족해야 한다.
- 자원의 식별
- 메시지를 통한 리소스 조작
- 자기서술적 메시지
- 애플리케이션의 상태에 대한 엔진으로서 하이퍼미디어
- 이미 많은 사람들이 해당 조건을 지키지 않아도 REST API라고 하기 때문에, HTTP API나 REST API를 거의 같은 의미로 사용하고 있다.
API URI 설계
- 가장 중요한 것은 리소스 식별
리소스 의미
- 회원을 등록하고 수정하고 조회하는게 리소스가 아니다
- 회원이라는 개념 자체가 바로 리소스
리소스 식별 방법
- 회원을 등록하고 수정하고 조회하는 것을 모두 배제
- 회원이라는 리소스만 식별하면 된다. => 회원 리소스를 URI에 매핑
- 회원 목록 조회 /members
- 회원 조회 /members/{id} => 구분을 어떻게?
- 회원 등록 /members/{id} => 구분을 어떻게?
- 회원 수정 /members/{id} => 구분을 어떻게?
- 회원 삭제 /members/{id} => 구분을 어떻게?
리소스와 행위를 분리
- URI는 리소스만 식별
- 리소스와 해당 리소스를 대상으로 하는 행위를 분리
- 리소스: 회원
- 행위: 조회, 등록, 삭제, 변경
- 리소스는 명사, 행위는 동사
HTTP 메서드 종류
주요 메서드
- GET: 리소스 조회
- POST: 요청 데이터 처리, 주로 등록에 사용
- PUT: 리소스를 대체, 해당 리소스가 없으면 생성
- PATCH: 리소스 부분 변경
- DELETE: 리소스 삭제
기타 메서드
- HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
- OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
- CONNECT: 대상 자원으로 식별되는 서버에 대한 터널을 설정
- TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
GET
- 리소스 조회
- 서버에 전달하고 싶은 데이터는
query를 통해서 전달 - 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는곳이 많아서 권장 X
- 조회할때는 GET을 쓰는게 유리하다.
- 서버에서는 GET으로 오면 캐싱하기도 편하다.
POST
- 요청 데이터 처리
- 메시지 바디를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리
- 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행
- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
- 새 리소스 생성(등록): 서버가 아직 식별하지 않은 새 리소스 생성
- 요청 데이터 처리: 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스스를 처리해야 하는 경우 / POST의 결과로 새로운 리소스가 생성되지 않을수도 있음
- 리소스 URL에서 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야함 -> 정해진것이 없다.
- 다른 메서드로 처리하기 애매한 경우에도 사용한다.
- JSON으로 조회 데이터를 넘겨야하는데, GET 메서드를 사용하기 어려운 경우,
- 애매하면 POST
Control URI
ex:) POST /orders/{orderID}/start-delivery
실무에서는 리소스만으로 URI를 설계하는데 한계가있다.
리소스로 최대한 URI를 설계하되 어쩔수 없는 경우에는 컨트롤 URI로 설계해야 한다.
/start-delivery처럼 동사로 된 리소스 경로를 사용
PUT
- 리소스를 대체
- 리소스가 있으면 대체
- 리소스가 없으면 생성
- 리소스를 완전히 대체해버림
- 중요! 클라이언트가 리소스를 식별
- 클라이언트가 리소스 위치를 알고 URI 지정
- POST와 차이점
PATCH
- 리소스 부분 변경
- PATCH가 지원안되는 경우도 있음 (POST 사용)
DELETE
- 리소스 제거
HTTP 메서드 속성
- 안전(Safe Methods)
- 멱등(Idempotent Methods)
- 캐시가능(Cacheable Methods)
안전 Safe
- 호출해도 리소스를 변경하지 않는다.
- 안전은 해당 리소스만 고려한다.
멱등 Idempotent
- 몇번을 호출하든 결과가 똑같다.
- 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.
- GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회됨
- PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
- DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
- POST: 멱등 X, 두 번 호출하면 같은 결제가 중복해서 발생할수 있다.
멱등 활용
- 자동 복구 메커니즘
- 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시해도 되는가? 판단 근거
캐시가능Catcheable
- 응답 결과 리소스를 캐시해서 사용해도 되는가?
- GET, HEAD, POST, PATCH 캐시 가능
- 실제로는 GET, HEAD 정도만 캐시로 사용
- POST, PATCH는 본문 내용까지 캐시 키로 고려해야하는데, 구현이 쉽지 않다.
Reference
Front-End 😲