[1] HTTP API 를 만들어보자!
ex) 회원 정보 관리 API를 만들어라.
- 회원 목록 조회 /read-member-list
- 회원 조회 /read-member-by-id
- 회원 등록 /create-member
- 회원 수정 /update-member
- 회원 삭제 /delete-member
- 이것은 좋은 URI 설계일까?
- 가장 중요한 것은 리소스 식별이다.
- 회원을 조회하라, 회원을 등록하라라는 자체가 아니라 '회원'이 리소스가 되어야 한다.
- 즉 조회하고 등록하는 '행위'와, 회원이라는 '리소스'를 분리하고, 회원 리소스를 URI에 매핑해야 한다.
- 회원 목록 조회 /members (계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장. member → members)
- 회원 조회 /members/{id}
- 회원 등록 /members/{id}
- 회원 수정 /members/{id}
- 회원 삭제 /members/{id}
리소스인 회원을 URI에 매핑했지만 조회, 등록, 수정 등의 행위를 구분하는 방법은 무엇인가?
HTTP는 그 행위로 GET, POST, PUT, PATCH, DELETE 등의 메서드를 제공한다!
- GET: 리소스 조회
- POST: 요청 데이터 처리, 주로 등록에 사용
- PUT: 리소스를 대체, 해당 리소스가 없으면 생성
- PATCH: 리소스를 부분적으로 변경
- DELETE: 리소스 삭제
- HEAD: GET과 동일하지만 바디(메세지 부분)를 제외하고 상태줄과 헤더만 반환
- OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
(*참고: 리소스(Resource)는 최근 스펙에서 Representation 이라는 단어로 바뀜)
[2] HTTP 메서드 - GET
- 리소스를 조회할 때 사용함
- 서버에 전달하고 싶은 데이터를 쿼리(Query Parameter, Query String)를 통해서 전달함
- 메세지 바디를 사용해서 데이터를 전달할 수도 있음(지원하지 않는 곳이 많아서 권장하지 않음)
[3] HTTP 메서드 - POST
- 메세지 바디를 통해 서버로 요청 데이터를 전달할 때 사용
- 서버는 요청 데이터를 처리함
- 주로 신규 리소스 등록, 프로세스 처리 등에 사용함
- POST 정리
- 새 리소스 생성(등록)
- 서버가 아직 식별하지 않은 새 리소스 생성
- 요청 데이터 처리
- 단순히 데이터를 생성하거나 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
- 예) "결제완료 → 배달시작 → 배달완료" 처럼 단순히 값 변경을 넘어서 프로세스의 상태가 변경되는 경우
- 예) /orders/{orderId}/start-delivery 와 같이 리소스 이외에 행위를 표현하는 URI가 사용될 수 있음 (컨트롤 URI)
- 다른 메서드로 처리하기 애매한 경우
- 예) JSON으로 조회 데이터를 넘겨야 하는데 GET 메서드를 사용하기 어려운 경우
[4] HTTP 메서드 - PUT
- 클라이언트가 리소스 위치를 알고 URI에 지정함 (POST와 다른점)
- 다음 그림처럼 /members/100 이라는 구체적인 리소스 위치에 PUT 요청을 함
- 그 위치에 리소스가 없으면 생성, 있으면 완전히 대체함(덮어쓰기)
- 따라서 PUT은 수정을 위한 용도로 쓰이는 것이 아님
[5] HTTP 메서드 - PATCH
- 리소스를 부분적으로 변경(수정)하고자 할 때 사용함
- 다음 그림처럼 수정하고자 하는 부분(age)의 정보만 보내면, 해당 부분만 수정이 됨
[6] HTTP 메서드 - DELETE
- 해당 리소스를 제거할 때 사용함
[7] HTTP 메서드의 속성
- 안전(Safe)
- 호출해도 리소스를 변경하지 않는다.
- GET, HEAD 메서드 등
- 멱등(Idempotent)
- f(f(x)) = f(x)
- 한 번 호출하든, 두 번 호출하든, 100번 호출하든 결과가 똑같다.
- 멱등 메서드
- GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
- PUT: 결과를 대체하기 때문에 같은 요청을 여러번 해도 최종 결과는 같다.
- DELETE: 결과를 삭제하기 때문에 같은 요청을 여러번 해도 삭제된 결과는 같다.
- POST: 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
- 활용
- 자동 복구 메커니즘
- 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는지 판단 근거
Q) 사용자가 GET 요청으로 리소스를 조회할 때, 다른 사용자가 중간에 그 리소스를 변경해서 재요청시 다른 리소스가 조회된다면?
A) 멱등은 외부 요인으로 중간에 리소스가 변경되는 것까지는 고려하지 않는다.
- 캐시 가능(Cacheable)
- 응답 결과 리소스를 캐시해서 사용해도 되는가?
- GET, HEAD, POST, PATCH 는 캐시 가능
- 실제로는 GET, HEAD 정도만 캐시로 사용함
[출처] "(인프런) 모든 개발자를 위한 HTTP 웹 기본 지식 - 김영한" 강의를 듣고 내용을 정리함.
'웹개발을 위한 HTTP 기초 지식' 카테고리의 다른 글
[HTTP] 6. HTTP 상태 코드 (0) | 2021.04.07 |
---|---|
[HTTP] 5. HTTP 메서드 활용 (0) | 2021.04.07 |
[HTTP] 3. HTTP 기본 (0) | 2021.04.06 |
[HTTP] 2. URI와 웹 브라우저 요청 흐름 (0) | 2021.04.06 |
[HTTP] 1. 인터넷 네트워크 (0) | 2021.04.06 |