HTTP API를 만들어보자
URI 설계에 가장 중요한 것은 리소스이다.
- 회원을 등록, 수정, 조회하는 것이 리소스가 아니다.
회원이라는 개념 자체가리소스이다.회원이라는 리소스만 식별하면 된다 => 회원 리소스를 URI에 매핑- 계층 구조상 상위를 컬렉션으로 보고
복수단어사용 권장 (member => members)
리소스와 행위를 분리하자.
리소스는 명사, 행위는 동사
주요 메서드
- GET: 조회
- POST: 등록
- PUT: 자체를 바꿈, 없으면 생성
- PATCH: 부분 변경
- DELETE: 삭제
기타 메서드
- HEAD: GET과 같지만, 헤더만 반환
- OPTIONS: 통신 가능 옵션, CORS에서 사용
- 잘 안씀
( CONNECT: 대상 리소스으로 식별되는 서버에 대한 터널 설정)
( TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행)
GET
- 조회
- 전달하고 싶은 데이터는 query (쿼리 파라미터, 쿼리 스트링)를 통해 전달
- 메시지 바디를 통해 전달할 수 있지만, 지원하지 않는 곳이 많아 권장하지 않음
POST
-
요청 데이터 처리
-
메시지 바디를 통해 서버로 요청 데이터 전달
-
메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
-
주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
-
이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함
- 새 리소스 생성 (등록)
- 서버가 아직 식별하지 않은 새 리소스 생성
- 요청 데이터 처리
- 단순한 데이터 생성 or 변경을 넘어서 프로세스를 처리해야 하는 경우
- ex) 주문 -> 결제 완료 -> 배달시작 -> 배달완료
- POST 결과로 새로운 리소스가 생성되지 않을 수도 있음
- ex) POST /orders/{orderId}/start-delivery (컨트롤 URI)
- 단순한 데이터 생성 or 변경을 넘어서 프로세스를 처리해야 하는 경우
- 다른 메서드로 처리하기 애매한 경우
- ex) JSON으로 조회 데이터를 넘겨야 하는데, GET를 사용하기 어려운 경우
- 애매하면 POST
PUT
- 리소스를 대체
- 있으면, 새로운 리소스로 완전히 대체 (덮어버림, 기존 것 지우고 새로)
- 없으면 생성
- 클라이언트가 리소스를 식별
PATCH
- 리소스 부분 변경
- PATCH 지원이 안되면 POST 쓰자.
DELETE
- 리소스 제거
속성
안전
- 호출해도 리소스를 변경하지 않는다.
- 계속 호출해서 로그 같은게 쌓여서 장애가 발생하면?
- 안전은 해당 리소스만 고려한다. 그런 부분까지 고려하지 않는다.
멱등
-
f(f(x)) = f(x)
-
한번 호출하든 100번 호출하든 결과가 똑같다.
-
멱등 메서드
- GET: 여러 번 조회해도 결과는 같다.
- PUT: 결과를 대체한다. 결과는 같다.
- DELETE: 결과를 삭제한다. 결과는 같다.
- POST는 멱등이 아니다!
-
자동 복구 메커니즘
멱등은 클라이언트가 DELETE 호출을 했는데 서버에서 응답이 없다,
클라이언트가 자동으로 DELETE 재시도 해도 문제가 없다.
재요청 중간에 다른 곳에서 리소스를 변경해버리면?
멱등은 외부 요인으로 중간에 리소스가 변경되는 것까지 고려하지 않는다.
- user1: GET -> username: A, age: 20
- user2: PUT -> age: 30
- user1: GET -> age: 30 (user2가 바꾼 데이터 조회)
=> 고려하지 않는다.
캐시가능
응답 결과 리소스를 캐시해서 사용해도 될까?
- GET, HEAD, POST, PATCH 캐시가능
- 실제는 GET, HEAD 정도만 캐시로 사용
- POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 어려움
References
https://www.inflearn.com/course/http-%EC%9B%B9-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC/dashboard
