HTTP 메서드

전문 요약 : 💡 API 설계는 리소스 중심의 URI 계층 구조를 활용한다. HTTP 메서드는 GET(조회), POST(데이터 처리 및 등록), PUT(리소스 대체 또는 생성), PATCH(리소스 일부 변경), DELETE(리소스 제거) 등이 있으며, 각 메서드는 안전, 멱등, 캐시 가능 속성을 가진다. 요약하면, 리소스 중심의 URI와 다양한 HTTP 메서드를 활용하여 안전하고 효율적인 API를 디자인할 수 있다.

1. HTTP API를 만들어보자

사진 및 강의 출처 : 모든 개발자를 위한 HTTP 웹 기본 지식

1) API URI 설계(Uniform Resource Identifier)

• 회원 목록 조회 /read-member-list

• 회원 조회 /read-member-by-id

• 회원 등록 /create-member

• 회원 수정 /update-member

• 회원 삭제 /delete-member

가장 중요한 것은 리소스 식별

2) API URI(Uniform Resource Identifier) 고민

1. 리소스의 의미는 뭘까?

• 회원을 등록하고 수정하고 조회하는게 리소스가 아니다!

  • 예) 미네랄을 캐라 -> 미네랄이 리소스

  • 회원이라는 개념 자체가 바로 리소스다.

1. 리소스를 어떻게 식별하는게 좋을까?

• 회원을 등록하고 수정하고 조회하는 것을 모두 배제

• 회원이라는 리소스만 식별하면 된다. -> 회원 리소스를 URI에 매핑

3) API URI 설계

리소스 식별, URI 계층 구조 활용

참고: 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장(member -> members)

• 회원 목록 조회 /members

• 회원 조회 /members/{id} -> 어떻게 구분하지?

• 회원 등록 /members/{id} -> 어떻게 구분하지?

• 회원 수정 /members/{id} -> 어떻게 구분하지?

• 회원 삭제 /members/{id} -> 어떻게 구분하지?

4) 리소스와 행위을 분리

가장 중요한 것은 리소스를 식별하는 것

1. URI는 리소스만 식별!

2. 리소스와 해당 리소스를 대상으로 하는 행위을 분리

• 리소스 : 회원

• 행위 : 조회, 등록, 삭제, 변경

1. 리소스는 명사, 행위는 동사

2. 행위(메서드)는 어떻게 구분할까? 답변 2.

2. HTTP 메서드 - GET, POST

1) HTTP 메서드 종류

주요 메서드

1. GET: 리소스 조회

2. POST: 요청 데이터 처리, 주로 등록에 사용

3. PUT: 리소스를 대체, 해당 리소스가 없으면 생성

4. PATCH: 리소스 부분 변경

5. DELETE: 리소스 삭제

기타 메서드

1. HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환

2. OPTIONS: 대상 리소스에 대한 **통신 가능 옵션(메서드)**을 설명(주로 CORS에서 사용)

3. CONNECT: 대상 리소스로 식별되는 서버에 대한 터널을 설정

4. TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행

2) GET

GET 이란?

1. 리소스 조회

2. 서버에 전달하고 싶은 데이터는 Query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달

3. 메세지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음

리소스 조회1 : 메세지 전달

리소스 조회2 : 서버 도착

리소스 조회3 : 응답 데이터

3) POST

POST란?

1. 요청 데이터 처리(데이터가 있)

2. 메시지 바디를 통해 서버로 요청 데이터 전달

3. 서버는 요청 데이터를 처리

• 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.

1. 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용

리소스 등록1 : 메세지 전달

리소스 등록2 : 신규 리소스 생성

리소스 등록3 : 응답 데이터

요청 데이터를 어떻게 처리한다는 뜻일까? 예시

1. 스펙 : POST 메서드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청

2. 예시로 POST의 기능

• HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공

  • 예) HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용

• 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시

  • 예) 게시판 글쓰기, 댓글 달기

• 서버가 아직 식별하지 않은 새 리소스 생성

  • 예) 신규 주문 생성

• 기존 자원에 데이터 추가

  • 예) 한 문서 끝에 내용 추가하기

• 정리: 이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함 -> 정해진 것이 없음

4) POST 정리

1. 새 리소스 생성(등록)

• 서버가 아직 식별하지 않은 새 리소스 생성

1. 요청 데이터 처리

• 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우

• 예) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우

• POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음

  • 예) POST /orders/{orderId}/start-delivery (컨트롤 URI)

1. 다른 메서드로 처리하기 애매한 경우

• 예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우

• 애매하면 POST

3. HTTP 메서드 - PUT, PATCH, DELETE

1) PUT : 리소스 수정보다는 갈아 치우는 느낌

1. 리소스를 대체

• 리소스가 있으면 대체

• 리소스가 없으면 생성

• 쉽게 이야기해서 덮어버림

1. 중요! 클라이언트가 리소스를 식별

• 클라이언트가 리소스 위치를 알고 URI 지정

• POST와의 차이점

리소스가 있는 경우 : 대체

리소스가 없는 경우 : 생성

주의! - 리소스를 완전히 대체한다

2) PATCH

PATCH란?

• 리소스 부분 변경

• PATCH가 안되는 서버에서는 POST를 사용하면 됨

• 요즘은 웬만하면 다

리소스 부분 변경

3) DELETE

• 리소스 제거

리소스 제거

4. HTTP 메서드의 속성

1) HTTP 메서드의 속성 종류

1. 안전(Safe Methods)

2. 멱등(Idempotent Methods)

3. 캐시가능(Cacheable Methods)

2) 안전(Safe)

1. 호출해도 리소스를 변경하지 않는다.

• Q: 그래도 계속 호출해서, 로그 같은게 쌓여서 장애가 발생하면요?

• A: 안전은 해당 리소스만 고려한다. 그런 부분까지 고려하지 않는다.

3) 멱등(Idempotent)

f(f(x)) = f(x)

1. 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다

2. 멱등 메서드

• GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.

• PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.

• DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.

• POST: 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다

1. 활용

• 자동 복구 메커니즘

• 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해 도 되는가? 판단 근거

1. Q: 재요청 중간에 다른 곳에서 리소스를 변경해버리면?

• 사용자1: GET -> username:A, age:20

• 사용자2: PUT -> username:A, age:30

• 사용자1: GET -> username:A, age:30 -> 사용자2의 영향으로 바뀐 데이터 조회

1. A: 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지는 않는다

4) 캐시 가능(Cacheable)

1. 응답 결과 리소스를 캐시해서 사용해도 되는가?

2. GET, HEAD, POST, PATCH 캐시가능

3. 실제로는 GET, HEAD 정도만 캐시로 사용

• POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않음💡 API 설계는 리소스 중심의 URI 계층 구조를 활용한다. HTTP 메서드는 GET(조회), POST(데이터 처리 및 등록), PUT(리소스 대체 또는 생성), PATCH(리소스 일부 변경), DELETE(리소스 제거) 등이 있으며, 각 메서드는 안전, 멱등, 캐시 가능 속성을 가진다. 요약하면, 리소스 중심의 URI와 다양한 HTTP 메서드를 활용하여 안전하고 효율적인 API를 디자인할 수 있다.