# HTTP 메서드
## HTTP API 생성
- 요구사항 : 회원 정보 관리 API 생성 (회원 목록 조회 / 회원 조회 / 회원 등록 / 회원 수정 / 회원 삭제)
API URI 설계 (Uniform Resource Identifier)
회원 목록 조회 : /read-member-list
회원 조회 : /read-member-by-id
회원 등록 : /create-member
회원 수정 : /update-member
회원 삭제 : /delete-member
- 과연, 이건 좋은 URI 설계일까?
- URI 설계의 가장 중요한 건 '리소스 식별' 이다.
리소스의 의미?
회원을 등록하고 수정하고 조회하는게 리소스가 아니다.
예를 들어미네랄을 캐라에서 리소스는 미네랄. (즉, 회원이라는 개념 자체가 바로 리소스)
리소스를 어떻게 식별?
회원을 등록하고 수정하고 조회하는 것을 모두 배제.
회원이라는 리소스만식별하면 됨. (회원 리소스를 URI에 매핑)
API URI 설계 (리소스 식별, URI 계층 구조 활용)
회원 목록 조회 : /members
회원 조회 : /member/{id}
회원 등록 : /members/{id}
회원 수정 : /members/{id}
회원 삭제 : /members/{id}
참고 : 계층 구조상 상위를 컬렉션으로 보고 복수 단어 사용 권장함.
(member -> members)
- 위와 같이 했을 때 문제 : 회원 조회 / 회원 등록 / 회원 수정 / 회원 삭제 구분을 어떻게 할지?....
리소스와 행위를 분리. (가장 중요한 것은 리소스를 식별하는 것)
URI는 리소스만 식별. (URI는 리소스를 판별할때 사용)
리소스와 해당 리소스를 대상으로 하는 행위를 분리.
리소스 : 회원
행위 : 조회 / 등록 / 삭제 / 변경
리소스는 명사, 행위는 동사(미네랄을 캐라)
- 그렇다면 행위(메서드)는 어떻게 구분?.. -> HTTP 메서드가 식별.
## HTTP 메서드 (GET, POST)
- GET : 리소스 조회
- POST : 요청 데이터 처리 (주로 등록에 사용)
- PUT : 리소스를 대체, 해당 리소스가 없으면 생성
- PATCH : 리소스 부분 변경
- DELETE : 리소스 삭제
- HEAD : GET 과 동이랗지만 메시지 부분을 제외, 상태 줄과 헤더만 반환
- OPTIONS : 대상 리소스에 대한 통신 가능 옵션 (메서드)을 설명 (주로 CORS에서 사용)
- CONNECT : 대상 자원으로 식별되는 서버에 대한 터널을 설정
- TRACE : 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
1. GET (리소스 조회)
서버에 전달하고 싶은 데이터는 query (쿼리 파라미터, 쿼리 스트링)를 통해 전달.
메시지바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아 권장하지 않음.
2. POST (요청 데이터 처리)
- 핵심 : 메시지 바디를 통해 서버로 요청 데이터 전달.
- 서버는 요청 데이터를 처리.
- 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능 수행.
- 주 용도 : 주로 전달된 데이터로 신규 리소스 등록 / 프로세스 처리에 사용.
- 스팩 : POST 메스드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 쵸어 한다.
POST는 다음의 기능에 사용.
1. HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공.
- 예) HTML, FROM에 입력한 정보로 회원가입, 주문 등에 사용
2. 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시.
- 예) 게시판 글쓰기, 댓글 달기
3. 서버가아직 식별하지 않은 새 리소스 생성.
- 예) 신규 주문 생성
4. 기존 자원에 데이터 추가.
- 예) 한 문서 끝에 내용 추가하기 등
참고 : 이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 한다.
(정해진 것이 없다.)
1. 새 리소스 생성(등록)
서버가 아직 식별하지 않은 새 리소스 생성
2. 요청 데이터처리
- 단순히 데이터를 생성하거나, 변경하는 것을 넘어 프로세스를 처리해야 하는 경우
예) 주문에서 결제완료 > 배달시작 > 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
- POS의 결과로 새로운 리소스가 생성되지 않을 수도 있다.
예) POST/orders/{orderId}/start-delivery (컨트롤 URI)
3. 다른 메서드로처리하기 애매한 경우
- 애매하면 POST 사용
예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
3. PUT (리소스를 완전히 대체)
- 리소스가 있으면 '완전히' 대체, 리소스가 없으면 생성 (덮어쓰기)
- 주의 : 리소스를 '완전히' 대체한다.
- 중요 : 클라이언트가 리소스를 식별. (클라이언트가 리소스 전체 위치를 알고 URI 지정 - POST와의 가장 큰 차이)
4. PATCH (리소스 부분 변경)
- 리소스를 부분적으로 변경할 때 사용. (PATCH 지원 안될 경우에는 POST 사용)
5. DELETE (리소스 제거)
## HTTP 메서드의 속성
1. 안전 (Safe Methods)
- 호출해도 리소스를 변경하지 않는 것.
- 계속 호출해서 로그가 쌓여장애가 발생한다면? -> 안전은 해당 리소스만을 고려.
- 멱등 (Idempotent Methods)
- 몇 번을 호출해도 결과가 동일.
2. 멱등 메서드
GET : 여러번 조회해도 같은 결과 조회.
PUT : 결과를 대체. (같은 요청 여러번 해도 최종 결과는 동일)
DELETE : 결과를 삭제. (같은 요청 여러번 해도 삭제된 결과 동일)
POST : 멱등이 아님!!!!!!! 두 번 호출하면 같은결제가 중복해서 발생할 수 있다.
- 멱등 활용 : 자동 복구 메커니즘에 활용.
- 재 요청 중간에 다른 곳에서 리소스를변경해 버리면? -> 멱등은 외부 요인으로 중간에 리소스가 변경되는 것은 고려하지 않음.
3. 캐시가능 (Cacheable Methods)
- 응답 결과 리소스를 캐시해서 사용해도 되는지?
- GET / HEAD / POST / PATCH 에서 캐시 가능.
- 실제로는 GET / HEAD 정도만 캐시로 사용. (POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현 쉽지 않음)