몬그로이

HTTP 메서드 본문

Organizing Docs/Spring Docs

HTTP 메서드

Mon Groy 2024. 5. 20. 22:21

GET

POST

PUT

PATCH

DELETE
HEAD

OPTIONS
CONNECT

TRACE


GET
리소스 조회
서버에 전달하고 싶은 데이터를 주로 query(쿼리 파라미터, 쿼리 스트링)를 통해 전달
메세지 바디를 사용해서도 전달할 수 있지만, 지원하지 않는 곳이 많아 권장하지 않음

POST
요청 데이터 "처리", 주로 등록에 사용
메세지 바디를 통해서 서버로 요청 데이터 전달
서버에서는 이 요청 데이터를 "처리"
주로 전달된 데이터로 신규 리소스 등록과 프로세스 처리에 사용
**다른 메서드로 처리하기 애매한 경우도 사용 - 애매하면 POST

"처리" 예시)
1. HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
>> HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용
2. 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메세지 게시
>> 게시판 글쓰기, 댓글 달기
3. 서버가 아직 식별하지 않은 리소스 생성( = 새 리소스 등록)
>> 신규 주문 생성
4. 기존 자원에 데이터 추가
>> 한 문서 끝에 내용 추가하기

**이 리소스 URI 에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 (알아서) 정해야 함
**POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
예) POST /orders/{orderId}/start-delivery (컨트롤 URI)

PUT
리소스를 대체 (덮기)
해당 리소스가 없으면 생성
중요! 클라이언트가 리소스를 식별 ← POST와 차이점


즉, 클라이언트가 리소스 위치를 알고 URI 지정
주의! 리소스를 완전히 대체한다 - 기존 내용 날아갈 수 있음
ex. 요청 : name 정보 x, age 40  // 서버: name : "A", age: 20  //인 경우
PUT으로 보내면 서버의 name 이 날아가 버림

PATCH
리소스 부분 변경
리소스 정보 날아가지 않음 ← PUT 과의 차이점


DELETE
리소스 삭제


HEAD
GET과 동일하지만 메세지 부분을 제외하고, 상태 줄과 헤더만 변환

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

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

TRACE
대상 리소스에 대한 경로를 따라 메세지 루프팩 테스트를 수행

 



HTTP의 안전
사용자 어플의 상태가 아니라 - 리소스의 안전만 고려한다

HTTP의 멱등 (Idempotent)
호출 결과가 항상 같음
GET, PUT, DELETE 가 해당
**POST는 멱등이 아님 - 두 번 호출하여 중복 결제 발생 가능
멱등의 활용
1. 자동 복구 메커니즘
2. 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가? 의 판단 근거
외부 요인에 의한 리소스 변경까지 고려하지 않는다
ex)
사용자1: GET -> username:A, age:20 
사용자2: PUT -> username:A, age:30
사용자1: GET -> username:A, age:30  <--- 사용자2의 영향으로 바뀐 데이터 조회

HTTP의 Cacheable

응답 결과 리소스를 캐시해서 사용 가능 - GET, HEAD, POST, PATCH 해당
**실제로는 GET, HEAD 정도만 캐시로 사용 - POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않기때문




클라이언트에서 서버로 데이터를 전송하는 방식 2가지

 

1. 쿼리 파라미터를 통한 데이터 전송
GET
주로 정렬 필터(검색어)

2. 메시지 바디를 통한 데이터 전송
POST, PUT, PATCH
회원 가입, 상품 주문, 리소스 등록, 리소스 변경

 


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

 

1. 정적 데이터 조회

이미지, 정적 텍스트 문서
GET 사용
일반적으로 쿼리 파라미터 없이 리소스 경로로 단순 조회 가능
예) 
GET /static/star.jpg HTTP/1.1
Host: localhost:8080

2. 동적 데이터 조회

GET, 쿼리 파라미터 사용 → 쿼리 파라미터를 기반으로 정렬 필터해서 결과를 동적으로 생성
주로 검색, 게시판 목록에서 정렬 필터(검색어)

조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용

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

POST 사용한 전송 → 저장

GET 을 사용한 전송 →  조회 (저장 불가)

회원 가입, 상품 주문, 데이터 변경

Content-Type: application/x-www-form-urlencoded 사용

• form의 내용을 메시지 바디를 통해서 전송(key=value, 쿼리 파라미터 형식)

• 전송 데이터를 url encoding 처리
  예) abc김 -> abc%EA%B9%80

참고: HTML Form 전송은 GET, POST만 지원

 


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

회원 가입, 상품 주문, 데이터 변경
서버 to 서버, 앱 클라이언트, 웹 클라이언트(Ajax)

백엔드 시스템 통신, 아이폰, 안드로이드
• POST, PUT, PATCH: 메시지 바디를 통해 데이터 전송
• GET: 조회, 쿼리 파라미터로 데이터 전달


• HTML에서 Form 전송 대신 자바 스크립트를 통한 통신에 사용(AJAX)
  예) React, VueJs 같은 웹 클라이언트와 API 통신
• Content-Type: application/json을 주로 사용 (사실상 표준)

  - JSON 외에 TEXT, XML 등이 있음

 


 

HTTP API 설계 예시 3종 외

 

◇ HTTP API - 컬렉션 (Collection)

  서버가 관리하는 리소스 디렉토리
  서버가 리소스의 URI를 생성하고 관리
  POST 기반 등록


예) 회원 관리 API  설계  (여기서 컬렉션은 /members)

-  회원 목록 /members -> GET
-  회원 등록 /members -> POST
-  회원 조회 /members/{id} -> GET
-  회원 수정 /members/{id} -> PATCH, PUT, POST
-  회원 삭제 /members/{id} -> DELETE

** 클라이언트는 등록될 리소스의 URI를 모른다.
** 서버가 새로 등록된 리소스 URI를 생성해준다.
   HTTP/1.1 201 Created
   Location: /members/100 


◇ HTTP API - 스토어(Store)

클라이언트가 관리하는 리소스 저장소

클라이언트가 리소스의 URI를 알고 관리

 PUT 기반 등록


예) 정적 컨텐츠 관리, 원격 파일 관리 API 설계  ( 여기서 스토어는 /files)

-  파일 목록 /files -> GET
-  파일 조회 /files/{filename} -> GET
-  파일 등록 /files/{filename} -> PUT
-  파일 삭제 /files/{filename} -> DELETE 
-  파일 대량 등록 /files -> POST

** 등록 특징: 클라이언트가 리소스 URI를 알고 지정한다.
   PUT /files/star.jpg 


◇ HTML FORM 사용
순수 HTML, HTML FORM  기준 GET, POST만 지원 → 제약이 있음

  제약을 해결하기 위해 동사로 된 리소스 경로 사용

• AJAX 나 Java Script 등을 사용하면 GET, POST, PUT,DELETE 사용 가능 (회원 API 참고)

 

예) 웹 페이지 회원 관리 API 설계

-  회원 목록 /members -> GET
-  회원 등록 폼 /members/new -> GET
-  회원 등록 /members/new, /members (택1) -> POST

-  회원 조회 /members/{id} -> GET
-  회원 수정 폼 /members/{id}/edit -> GET
-  회원 수정 /members/{id}/edit, /members/{id} -> POST
-  회원 삭제 /members/{id}/delete -> POST

더보기

회원 등록시  /members/new 추천

만약에 slushy-members-and-new를 해서 서버에 던졌는데

서버에서 뭔가 문제가 있어서 다시 포스트의 최종 결과를 그냥 회원 등록 폼으로 다시 보내야 되는 경우

회원등록 폼과 둘이 맞춰 놓으면 경로가 안 바뀌고 깔끔하게 해결 됨

이렇게 슬러시 members로 이동해버리면 URI 경로 자체가 이동해버리기 때문에

리플레시 하거나 하면 다시 폼으로 못 돌아감

 

 

**컨트롤 URI 

  HTTP 메서드로 해결하기 애매한 경우 사용(HTTP API 포함)
  예시에서 POST의 /new, /edit, /delete가 컨트롤 URI

 

참고하면 좋은 URI 설계 개념

 

 문서(document) 
• 단일 개념(파일 하나, 객체 인스턴스, 데이터베이스 row)
• 예) /members/100, /files/star.jpg


컬렉션(collection) 
• 서버가 관리하는 리소스 디렉터리
• 서버가 리소스의 URI를 생성하고 관리
• 예) /members


스토어(store) 
• 클라이언트가 관리하는 자원 저장소
• 클라이언트가 리소스의 URI를 알고 관리
• 예) /files


컨트롤러(controller), 컨트롤 URI 
• 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행
• 동사를 직접 사용
• 예) /members/{id}/delete

'Organizing Docs > Spring Docs' 카테고리의 다른 글

QueryDSL  (0) 2024.06.30
Entity-Table 에 사용하기 좋은 어노테이션 기능  (0) 2024.06.30
MVC 의 annotation 들  (0) 2024.05.25
Bean의 생명주기와 그것을 알게 되었을 때의 이점  (0) 2024.05.23
Spring - SOLID  (0) 2024.05.19