HTTP 메서드

https://surrealcode.tistory.com/113

HTTP 기본

HTTP 메서드를 알아보기 전 이전 포스팅을 참고하자.

 

- HTTP API 메서드를 만들어보자.

요구사항은 다음과 같다.

회원 정보 관리 API를 만들어라

1. 회원 목록 조회

2. 회원 조회

3. 회원 등록

4. 회원 수정

5. 회원 삭제

 

위 요구사항을 기반으로 URI를 만들었다고 가정하자.

이 설계과 과연 좋은 URI 설계일까?

URI에서 가장 중요한 점은 리소스 식별이다.

 

리소스의 의미는 뭘까?

- 회원을 등록하고 수정하고 조회하는것이 리소스가 아니다. 회원이라는 개념 자체가 바로 리소스이다.

 

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

- 회원을 등록하고 수정하고 조회하는 것을 모두 배제하고, 회원이라는 리소스만 식별하여 URI를 매핑한다.

 

리소스와 행위를 분리를 해야한다.

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

 

- URI는 리소스만 식별하도록 설계해야한다.

- 리소스와 해당 리소스를 대상으로 하는 행위를 분리한다.

  - 리소스 : 회원

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

 

 

---> 이러한 행위들은 HTTP 메서드들이 대신 식별하도록 해준다.

HTTP 메서드는 클라이언트가 서버에 무언갈 요청할때 기대하는 행동이다.

GET : 리소스 조회

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

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

PATCH : 리소스 부분 변경

DELETE : 리소스 삭제

...

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

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

CONNECT : 대상 자원으로 식별되는 서버에 대한 터널을 설정한다.

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

 

- HTTP 메서드 - GET, POST

GET

- GET은 리소스를 조회한다.

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

- 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 권장하진 않는다.

 

클라이언트가 GET을 통해 /members/100(쿼리)를 요청했다. 그럼 서버는 그 쿼리에 맞는 결과값을 찾고 JSON형식으로 반환하게 된다.

 

 

 

POST

- POST는 요청 데이터를 처리한다.

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

- 서버는 요청 데이터를 처리한다(메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.)

- 주로 전달된 데이터로 신규 리소스를 등록하거나, 프로세스 처리에 사용한다.

/member라는 곳에 POST로 전달한다.

서버에서 메시지를 까보니 POST 방식으로 온 신규 회원 생성이다.

신규 리소스 식별자를 생성한다.

이후 응답을 보내준다.

 

보통 201로 보낸다. 응답데이터를 보낼 때 생성된 리소스의 로케이션(패스)도 보내주고, 등록된 자원의 데이터도 보내주게 된다.

 

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

ex) POST는 다음과 같은 기능에 사용된다.

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

- 게시판, 블로그 등 그룹에 메시지를 게시한다.

- 서버가 아직 식별하지 않은 새 리소스를 생성한다.

- 기존 자원에 데이터를 추가한다.

 

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

 

POST의 쓰임새

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

2. 요청 데이터 처리

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

 

 

- HTTP 메서드 - PUT, PATCH, DELETE

PUT

- PUT은 리소스를 "완전히" 대체한다.

  - 리소스가 있으면 대체, 만약 리소스가 없다면 생성한다.

  - 쉽게 풀어서 덮어버린다고 생각하면 된다.

--> PUT은 클라이언트가 리소스를 식별한다. 클라이언트가 리소스의 위치를 알고 URI를 지정한다.

주의 ! - PUT은 리소스를 완전히 대체한다.(기존 값을 삭제하고 대체하기 때문에 값이 정확히 맞아야 한다. 필드가 삭제될 위험이 있다.)

 

PATCH

- PATCH는 PUT과 다르게 리소스의 부분 변경이 가능하다.

 

 

DELETE

- 마지막으로 DELETE는 리소스를 제거하는 것이다.

 

 

- HTTP 메서드의 속성

- 안전(Safe Methods)

안전은 호출해도 리소스를 변경하지 않는다. ex) GET

Q : 계속 호출해서 로그같은게 쌓여 장애가 발생하면 어떻게 되나?

A : 안전은 해당 리소스만 고려한다. 그런 부분은 고려 대상이 아니다.

 

- 멱등(Idempotent Methods)

f(f(x)) = f(x)이다.

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

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

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

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

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

 

- 멱등의 활용

  1. 자동 복구 메커니즘

  2. 서버가 TIMEOUT 등으로 정상 응답을 주지 못했을 때, 클라이언트가 같은 요청을 해도 되는가? 의 판단 근거가 된다.

 

Q : 만약 재요청 중간에 다른 곳에서 리소스를 변경해버리면 어떡할까?

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

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

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

 

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

 

- 캐시가능(Cacheable Methods)

** 캐시 : 서버에 큰 리소스를 요청한 것을 내 로컬 PC 웹 브라우저나 다른 중간 캐시 서버들이 저장을 하는 것을 말한다.

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

GET, HEAD, POST, PATCH는 캐시 가능하다.

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

  - POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않다.