[NetWork] HTTP 메서드

̱ HTTP 메서드

 

HTTP API 를 만들어보면서 HTTP 메서드에 대해 알아보겠습니다.

 

 

현재와 같은 요구사항이 있다고 가정했을 때

 

 

위와 같은 URI 를 생성할 수 있는데요. 각 요청에 맞게 URI 가 그럴 듯하게 설계되었다고 생각할 수 있지만

HTTP API 를 설계할 때는 리소스 식별이 가장 중요합니다. 여기서 말하는 리소스는 회원을 조회하고 등록하는게

아닌 회원 그 자체입니다. 그렇기에 리소스인 회원만 URI 에 매핑하고 조회, 등록같은 행위는 모두 배제해야 합니다.

 

 

앞에서 설명한대로 다시 API URI 를 설계해봤습니다. 여러 명의 회원이 합쳐져 있으니 리소스를 복수형으로 나타내

members 라고 작명하고, 특정 회원을 식별하기 위해 그 뒤에 식별자가 들어옵니다. 그럼 이렇게 리소스를 URI 에

매핑했다면 리소스에 대한 행위는 어떻게 작성해야할까요?

이 때 사용하는게 HTTP 메서드입니다.

 

 

̱ GET 메서드

 

 

GET 메서드는 리소스를 조회할 때 사용됩니다. 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를

통해서 전달합니다. 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 서버들이 많아서

권장하지 않습니다.

 

GET 메서드 예시

 

 

클라이언트가 /members uri 를 GET 메서드로 서버에 요청합니다.

 

 

서버에서는 클라이언트가 요청한 100번 회원의 데이터를 DB 에서 조회하여 json 형식으로 변환합니다.

 

 

클라이언트에게 전송합니다.

 

̱ POST 메서드

 

 

POST 메서드는 요청 데이터 처리를 목적으로 메시지 바디를 통해 서버로 요청 데이터를 전달할 때 사용합니다.

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

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

 

POST 메서드예시

 

 

서버에서는 POST 방식으로 /members 요청이 들어오면 전달받은데이터를 저장하기로 약속되어 있는 상황입니다.

클라이언트가 전달할 데이터를 메시지 바디에 넣고 /members uri 를 POST 메서드로 서버에 요청합니다.

 

 

서버에서는 전달받은 데이터를 DB 에 등록하고 등록된 리소스의 식별자를 생성합니다.

 

 

새로 생성된 리소스의 식별자를 자원이 생성된 경로에 붙이고 클라이언트에게 등록된 데이터와 리소스의 식별자를

응답 데이터로 전송합니다.

 

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

 

POST 메서드가 사용되는 예시는 다음과 같습니다. .

1.  HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공할 때 사용합니다.

ex) HTML FORM에 입력한 정보로 회원 가입, 주문 등

2. 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시할 때 사용합니다.

ex) 게시판 글쓰기, 댓글 달기

3. 서버가 아직 식별하지 않은 새 리소스 생성할 때 사용합니다.

ex) 신규 주문 생성

4. 기존 자원에 데이터를 추가할 때 사용합니다.

ex) 한 문서 끝에 내용 추가

 

정리

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

서버가 아직 식별하지 않은 새 리소스를 생성할 때 사용합니다.

2. 요청 데이터 처리

단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우에 사용합니다.

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

POST 의 결과로 새로운 리소스가 생성되지 않을 수도 있습니다.

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

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

ex) JSON 으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우에 사용합니다.

 

결론! 이 리소스 URI 에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 합니다.

 

̱ PUT 메서드

 

 

 

PUT 메서드는 리소스를 대체할 때 사용합니다. 리소스가 있으면 대체, 리소스가 없으면 생성하는데

쉽게 이야기해서 덮어쓰기라고 할 수 있습니다.

중요!

클라이언트가 리소스를 식별 합니다.

클라이언트가 리소스 위치를 알고 URI 를 지정하는 부분이 POST 와의 차이점이라고 할 수 있습니다.

POST: /members

PUT:/members/100

 

PUT 메서드 예시

 

 

 

리소스가 있는 상태에서 클라이언트가 전달할 데이터를 메시지 바디에 넣고 /members/100 uri 를 PUT 메서드로

 서버에 요청합니다. 100번 회원의 데이터가 전달받은 데이터로 변경됩니다.

 

 

 

반대로 리소스가 존재하지 않는다면 전달된 데이터로 리소스를 생성합니다.

 

 

 

리소스가 있을 때 PUT 메서드를 사용해 요청하면 리소스에 해당되는 데이터를 전달받은 데이터로 덮어버리기

때문에 전달하는 데이터에 빠진 값이 있는지 확인해야합니다. 

 

̱ PATCH 메서드

 

 

PATCH 메서드는 리소스를 부분 변경할 때 사용합니다.

 

PATCH 메서드예시

 

 

 

PUT 메서드와 달리 덮어쓰기가 아닌 전달된 데이터만 부분 변경됩니다.

 

̱ DELETE 메서드

 

 

DELETE 메서드는 리소스를 제거할 때  사용합니다.

 

DELETE 예시

 

 

 

클라이언트가 /members/100 uri 를 DELETE 메서드로 서버에 요청합니다.

서버는 식별자가 100번에 해당되는 회원의 데이터를 삭제합니다.

 

̱ 이 외의 나머지 메서드

 

 

앞에서 설명한 5가지 메서드 외에 나머지 메서드들입니다.

ONNECT 와 TRACE 는 잘 사용하지 않습니다.

 

̱ HTTP 메서드의 속성

 

 

1. 안전(Safe Methods)

호출해도 리소스를 변경하지 않는걸 의미합니다. 만약 계속 호출해서, 로그 같은게 쌓여서 장애가 발생할

수 있지만 안전은 해당 리소스의 변경 여부만 고려합니다. 

 

2. 멱등(Idempotent Methods)

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

한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같은걸 의미합니다.

멱등 메서드

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

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

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

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

 

멱등의 활용

자동 복구 메커니즘 

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

 

만약 재요청 중간에 다른 곳에서 리소스를 변경해버리면 될까요?

ex)

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

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

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

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

 

3. 캐시가능(Cacheable Methods)

응답 결과 리소스를 캐시해서 사용할 수 있는지를 의미합니다.

클라이언트가 웹 브라우저를 통해 서버에 용량이 큰 이미지를 요청하면 웹 브라우저는 해당 이미지를 캐시해둡니다.

같은 이미지를 다시 요청한다면 다시 다운로드하지 않기 위해서입니다. 

웹 브라우저는 GET, HEAD, POST, PATCH 메서드로 요청했을 때 캐시할 수 있지만

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

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

 

̱ HTTP 메서드 활용

 

클라이언트에서 서버로 데이터를 전송하는 방식은 크게 2가지입니다.

1. 쿼리 파라미터를 통한 데이터 전송 

GET 에서 많이 사용하고 정렬필터나 검색어를 사용할 때 이 쿼리 파라미터를 많이 사용합니다. 

2. 메시지 바디를 통한 데이터 전송

POST, PUT, PATCH 에서 사용되며 회원 가입, 상품 주문과 같이 리소스를 등록하거나 변경하는데에 사용합니다. 

 

클라이언트에서 서버로 데이터를 전송하는 4가지 상황

1. 정적 데이터 조회

 

 

이미지, 정적 텍스트 문서를 조회할 때 사용합니다. 정적 데이터를 조회할 때는 쿼리 파라미터를 사용하지 않으며 

리소스 경로로 단순하게 조회할 수 있습니다.

 

2. 동적 데이터 조회

 

 

주로 검색, 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용합니다.

조회는 GET 을 사용하며, GET 은 쿼리 파라미터를 사용해서 데이터를 전달합니다.

 

3. HTML Form을 통한 데이터 전송

 

 

 

회원 가입, 상품 주문, 데이터 변경할 때 사용합니다. 웹 브라우저는 type 이 submit 인 버튼을 누르면 Form 태그의 정보를 

취합해 action 에 작성된 경로로 method 에 명시된 메서드로 요청을 하게 되는데, Content-Type을 보면

x-www-form-urlencoded 라고 되어있습니다.form-urlencoded 는  body에 담긴 내용을 인코딩합니다.

만약 method 가 GET 으로 되어있다면 메시지 바디에 담겨있는 내용이 쿼리 스트링으로 경로 뒤에 붙여집니다. 

 

 

파일이나 이미지 같은 데이터를 전송할 때는 form 태그의 enctype 속성의 값을 multipart/form-data 로 작성해

해당 폼에 파일이 있다는 것을 표시합니다. 데이터가 multipart/form-data 형식이면 바이너리 데이터로 전송되며

HTTP 메시지에 임의의 구분자인 boundary=——-XXX 로 가 Form 데이터간 구분을 지어줍니다.

HTML Form 전송은 GET, POST 메서드만 지원합니다. 

 

4. HTTP API를 통한 데이터 전송

 

 

회원 가입, 상품 주문, 데이터 변경할 때 사용하며 서버와 서버끼리, 앱 클라이언트,

웹 클라이언트(Ajax)와 통신할 때 사용합니다. 

POST, PUT, PATCH: 메세지 바디를 통해 데이터를 전송할 때 사용합니다.

GET: 조회, 쿼리 파라미터로 데이터 전달할 때 사용합니다.

Content-Type: application/json을 주로 사용합니다. TEXT, XML 도 있지만 현재는 JSON 이 사실상 표준입니다.

 

HTTP API 설계 예시

 

HTTP API - 컬렉션

 POST 기반 등록 

ex) 회원 관리 API 제공

HTTP API - 스토어 

PUT 기반 등록 

ex) 정적 컨텐츠 관리, 원격 파일 관리 

HTML FORM 사용

GET, POST 만 지원합니다.

ex) 웹 페이지 회원 관리 

 

회원 관리 시스템 API 설계 예시 - POST 기반 등록

회원 목록 /members -> GET

회원 정렬 조건이나 검색 조건이 필요하면 쿼리 파라미터를 설계하면 됩니다.

회원 등록 /members -> POST

회원 조회 /members/{id} -> GET

회원 수정 /members/{id} -> PATCH, PUT, POST

PUT은 덮어쓰기고 PATCH 는 부분적 업데이트이기 때문에 회원 정보 수정은 PATCH 가 좋습니다. 

하지만, 수정이 전부 다 변경해줘야 하는 경우 ( ex) 게시판 글 수정하기 ) 에는 PUT을 쓰는게 좋을 수도 있습니다.

어떤 메서드를 사용할지 애매하다면 POST 를 사용할 수도 있습니다.

회원 삭제 /members/{id} -> DELETE

 

회원 관리 시스템 예시 POST - 신규 자원 등록 특징

1. 클라이언트는 등록될 리소스의 URI를 모르는 상황

회원 등록 /members -> POST 

POST /members 

2. 서버가 새로 등록된 리소스 URI 를 생성해줍니다. 

HTTP/1.1 201 Created

Location: /members/100 

3. 컬렉션(Collection)

서버가 관리하는 리소스 디렉토리

서버가 리소스의 URI 를 생성하고 관리

여기서 컬렉션은 /members 입니다.

 

파일 관리 시스템 API 설계 예시 - PUT 기반 등록

파일 목록 /files -> GET 

파일 조회 /files/{filename} -> GET 

파일 등록 /files/{filename} -> PUT 

새로운 파일을 업로드하면 기존 파일이 사라지기 때문에 이 떄는 PUT 메서드가 적합합니다.

파일 삭제 /files/{filename} -> DELETE 

파일 대량 등록 /files -> POST

 

PUT - 신규 자원 등록 특징

클라이언트가 리소스 URI를 알고 있어야 합니다.

파일 등록 /files/{filename} -> PUT

PUT /files/star.jpg

클라이언트가 직접 리소스의 URI를 지정합니다.

스토어(Store)

클라이언트가 관리하는 리소스 저장소이며, 클라이언트가 리소스의 URI를 알고 관리합니다.

여기서 스토어는 /files 입니다.

 

POST 와 PUT 두 방식중 무엇을 많이 쓸까요? 

대부분 실무에서는 POST 기반의 컬렉션을 사용하고,  PUT 방식은 파일 관리같은 특수한 경우에만 사용합니다.

 

HTML FORM 사용

HTML FORM 은 GET, POST 만 지원합니다. AJAX 같은 기술을 사용해서 다른 HTTP 메서드를 사용할 수 있습니다.

순수 HTML, HTML FORM 으로만 보면 GET, POST만 지원하므로 제약이 있습니다.

 

HTML FORM 설계 예시

회원 목록 /members -> GET

회원 등록 폼 /members/new -> GET

회원등록 버튼을 누르면 회원 등록 폼 페이지로 이동합니다.

회원 등록 /members/new, /members -> POST

/members/new 로 페이지 이동과 회원 등록시 URL 경로를 맞추고 전송 방식만 다르게 하는 방식과

폼을 가져올때는 /new 를 통해 가져오지만 회원 등록은 /members 으로 하는 방식이 있습니다.

경로를 맞추는 방식을 사용 하면 Validation 작업으로 새로 고침되어 동일 페이지에 가야하는경우

간단하게 이전(동일) 페이지로 이동할 수 있습니다

회원 조회 /members/{id} -> GET

회원 수정 폼 /members/{id}/edit -> GET

회원 수정 /members/{id}/edit, /members/{id} -> POST

회원 삭제 /members/{id}/delete -> POST

삭제인데 POST 메소드를 사용한다. HTML FORM에서는 GET, POST만 사용할 수 있다는 제약때문에 어쩔수 없이

 URI 경로에 삭제하겠다는 행위를 작성함으로써 기능을 구현합니다. 이런 URI 를 컨트롤 URI 라 합니다

.

컨트롤 URI 

HTML FORM  은 GET, POST 만 지원하므로 제약이 있습니다.

이런 제약을 해결하기 위해 동사로 된 리소스 경로인 컨트롤 URI 를 사용합니다.

POST  의 경우 컨트롤 URI/new, /edit, /delete.

이렇게 컨트롤 URI 는 HTTP 메서드로 해결하기 애매한 경우에 사용할 수 있습니다.(HTTP API 포함)

 

정리

HTTP API - 컬렉션 

POST 기반으로 등록합니다. 

서버가 리소스 URI 를 결정합니다.

HTTP API - 스토어

PUT 기반으로 등록합니다. 

클라이언트가 리소스 URI 를 결정합니다. 

HTML FORM 사용 

순수 HTML + HTML form 울 사용합니다. 

GET, POST 만 지원합니다.

 

참고하면 좋은 URI 설계 개념

문서(document)

단일 개념입니다. (파일 하나, 객체 인스턴스, 데이터베이스 row)

ex) /members/100, /files/star.jpg

컬렉션(collection) 

서버가 관리하는 리소스 디렉터리를 의미합니다.

서버가 리소스의 URI 를 생성하고 관리합니다.

ex) /members

스토어(store) 

클라이언트가 관리하는 자원 저장소입니다.

클라이언트가 리소스의 URI 를 알고 관리합니다.

ex) /files

컨트롤러(controller), 컨트롤 URI 

문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스를 실행합니다.

동사를 직접 사용하ㅓㅂ니다.

ex) /members/{id}/delete