#4. [HTTP] 클라이언트 서버 구조와 HTTP 특징

HTTP 메서드

- HTTP API를 만들어보자

- HTTP 메서드 - GET, POST

- HTTP 메서드 - PUT, PATCH, DELETE

- HTTP 메서드의 속성

 

 

요구사항

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

- 회원 목록 조회

- 회원 조회

- 회원 등록

- 회원 수정

- 회원 삭제

 

요구 사항에 따라 URL를 설계한다.

API URI 설계

URI(Uniform Resource Identifier)

- 회원 목록 조회 - /read_member_list

- 회원 조회 - /read_member

- 회원 등록 - /insert_member

- 회원 삭제 - /delete_member

- 회원 수정 - /modify_member

 

이렇게 설계하는게 좋은 설계일까?

- 리소스의 의미는 뭘까?

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

  * 회원이라는 개념이 리소스다.

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

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

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

 

API URI 설계

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

- 회원 목록 조회 /members

- 회원 조회 /members/{id}

- 회원 등록 /members/{id} ?

- 회원 수정 /members/{id} ?

- 회원 삭제 /members/{id} ?

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

 

리소스와 행위를 분리

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

- URI는 리소스만 식별!

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

  * 리소스 : 회원

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

- 리소스는 명사, 행위는 동사 (미네랄을 캐라)

- 행위(메서드)는 어떻게 구분?

 

즉, URI는 오로지 행위가 아닌 리소스만을 구분해야 한다. 따라서 회원과 관련된 API들의 공통적인 리소스가 members/{id} 이고, 행위는 GET, POST와 같은 메서드로 구분해야 한다.

 

HTTP 메서드 종류

주요 메서드

- GET : 리소스 조회

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

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

- PATCH : 리소스 부분 변경

- DELETE : 리소스 삭제

(Representation으로 Resource가 바꼈음.)

 

HTTP 메서드 종류

기타 메서드

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

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

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

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

(HTTP 메서드는 이것 외에도 많다.)

 

 

GET

GET /search?q=hello&hi=ko HTTP/1.1
Host : www.google.com

- 리소스 조회

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

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

(메시지 바디 전달이 가능하나 보통 message body를 넣지 않음 호환성 문제)

 

 

GET 요청 예)

리소스 조회 1 - 메시지 전달

GET /members/100 HTTP/1.1
Host: localhost:8080

 

 

/members/100 응답 메시지 (예 JSON)

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 34
{
  "username": "young",
  "age":20
}

{
  "username": "young",
  "age":20
}

(응답 메시지의 message body가 HTML형식일수도 XML 형식일수도....)

 

 

POST

- 요청 데이터 처리

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

- 서버는 요청 데이터를 처리

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

(물론 이 처리에대한 약속을 서버와 클라이언트가 약속을 한다.~)

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

 

POST

리소스 등록1 - 메시지 전달

POST /members HTTP/1.1
Content-Type: application/json

{
  "username": "yound",
  "age": 20
}

(서버와 클라이언트에서 POST요청이 오고, 메시지바디를 받으면 서버쪽에서 이 메시지바디의 내용으로 회원을 등록하기로 약속)

 

POST

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

 

서버에서 이 데이터를 받아서 요청을 열어보겠지? 그리고 나서 message body에 있는 내용을 참고하여 신규 리소스를 만들어서 등록

 

POST

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

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 34
Location: /members/100

{
    "username": "yound",
    "age": 20
}

(보통 POST 요청을 회원 등록으로 사용한다고 했을 때 응답 status code로 201을 보낸다. 자원이 생성이 완료됬다는 의미이며, header로 Location도 같이 보내준다.)

 

 

POST

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

- 스펙: POST 메서드는 Resource-target이 Resource의 고유 한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청

- 예를 들어 POST는 다음과 같은 기능에 사용된다.

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

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

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

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

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

    * 예) 신규 주문 생성

  * 기존 지원에 데이터 추가

    * 예) 한 문서 끝에 내용 추가

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

 

POST 

정리

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

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

2. 요청 데이터 처리

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

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

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

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

(리소스 단위로 URI 설계가 힘들 때 이렇게 뒤에 행동을 붙여준다. 이런걸 Control URI라고 부른다.)

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

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

  * 애매하면 POST 

 

(그러니까 POST를 새로운 리소스의 생성이라는 것으로만 한정해서 이해하는것이 아닌 client-server간에 약속을 통해 request에 실려있는 message body를 request-target에 따라 처리하는 요청이다.)

 

조회용으로 message body를 실어서 request를 보내고 싶은데 GET도 가능은하다. 다만, 대부분의 서버에서 GET request가 들어오면 message body를 처리하지 않는 경우가 많기 때문에 이런 경우에는 조회이지만 POST요청을 보내는 것이 맞다. (query parameter가 아님)

 

POST는 무엇이든 할 수 있다. GET request는 기본적으로 캐싱을 한다. 그런데 POST request는 대개 데이터 변경, 프로세스 진행, 어쩔수 없는 경우 등에는 POST request를 쓰는것이 현명하다!!!!

 

 

PUT

- 리소스를 대체

  * 리소스가 있으면 대체

  * 리소스가 없으면 생성

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

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

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

  * POST와 차이점

PUT /members/100 HTTP/1.1
Content-Type: application/json

{
  "username": "world",
  "age": 111
}

POST request

POST /members HTTP/1.1
Content-Type: application/json

{
  "username": "hello",
  "age": 20
}

 

자 위의 PUT 요청과 POST 요청의 가장 큰 차이점은 PUT은 request-target의 구체적인 위치를 client가 알고 있다는 것이다!!!!!

(PUT는 이렇게 /members/100 위치를 정확하게 지정!!)

 

 

PUT
리소스가 있는 경우1

PUT /members/100 HTTP/1.1
Content-Type: application/json

{
  "username": "old",
  "age": 50
}

 

기존 /members/100

{
  "username": "hello",
  "age": 20
}

 

대체 /members/100

{
  "username": "old",
  "age": 50
}

(만약 리소스가 없는 경우에는 그냥 해당 위치로 신규 리소스가 생성됨.)

 

 

PUT

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

PUT /members/100 HTTP/1.1
Content-Type: application/json

{
  "age": 50
}

예를 들어 이렇게 나이만 50으로 대체하고 싶어서 Message body에 변경할 age만 실어서 PUT 요청을 보낸다면????????

 

결과 /members/100

{
  "age": 50
}

완전히 대체되므로 해당 데이터만 존재하게 된다.

PUT은 사실 리소스 수정 요청이아닌 대체 요청이다!!!!!

그러면 수정하고 싶다면 어떤 요청을 보내야 할까? 바로 PATCH요청을 보내면 된다.

 

PATCH

리소스 부분 변경1

PATCH /members/100 HTTP/1.1
Content-Type: application/json

{
  "age": 50
}

 

결과

{
  "username": "hello",
  "age": 50
}

 

 

DELETE

- 리소스 제거

DELETE /members/100 HTTP/1.1
Host: localhost:8080

(참고로 PATCH가 지원되지 않는 서버도 있다. 이런 경우 POST를 쓰면 된다. 무적의 POST)

 

 

HTTP 메서드의 속성

- 안전(Safe Methods)

- 멱등(Idempotent Methods)

- 캐시가능(Cacheable Methods)

 

안전

Safe

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

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

- A: 안전은 해당 리소스만 고려함. 그런 부분은 고려하지 않음

(GET, HEAD 요청이 있다.)

 

 

멱등

Idempotent

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

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

- 멱등 메서드

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

  * PUT : 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다. (기존걸 날리고 덮어버리므로)

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

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

(중복 결제 자체가 멱등하다고 볼 수 없음)

 

- 활용

  * 자동 복구 매커니즘

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

 

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

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

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

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

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

(즉, 동일한 사용자가 동일한 요청을 하는 것으로만 한정해서 고려함.)

 

 

캐시가능

Cacheable

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

- GET, HEAD, POST, PATCH 캐시가능

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

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

 

예를 들어 웹브라우저에 인터넷에서 크기가 큰 이미지 리소스를 다운로드 하라는 요청을 보냈다고 해보자.

인터넷을 통해 다운받게 되면 느릴 수 밖에 없다. 그래서 처음 다운받을 때는 인터넷을 통해 다운받기 때문에 느리지만, 그 다음에 똑같은 이미지 리소스에 대한 다운로드 요청을 웹 브라우저가 받는다면 이미 캐시 메모리에 이미지 리소스가 저장되어 있기 때문에 웹브라우저에서는 캐시 메모리에 저장된 이미지를 로드해온다.

(캐시를 하려면 key가 일치해야 한다. POST는 message body까지 일치해야 하기 때문에 복잡하다. 근대 GET은 URL을 key로 잡으면 되기 때문에 아주 심플하다. 그래서 이를 캐시로  사용한다.

실무에서는 GET만 캐시로 사용한다고 생각해도 무방하다.)