[HTTP] HTTP 메서드

HTTP 메서드

• HTTP API를 만들어보자
• HTTP 메서드 - GET, POST
• HTTP 메서드 - PUT, PATCH, DELETE
• HTTP 메서드의 속성

HTTP API 만들기

Example.요구사항 : 회원 정보 관리 API 만들기

• 회원 목록 조회
• 회원 조회
• 회원 등록
• 회원 수정
• 회원 삭제

API URI 설계

• 회원 목록 조회
  • /read-member-list
• 회원 조회
  • /read-member-by-id
• 회원 등록
  • /create-member
• 회원 수정
  • /update-member
• 회원 삭제
  • /delete-member

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

• URI는 리소스를 기준으로 설계를 해야한다.
  • URI에서 가장 중요한 것은 리소스 식별이다
• 리소스의 의미?
  • 회원을 등록하고 수정하고 조회하는 것이 아님
  • ex) 미네랄을 캐는 동작에서 미네랄이 리소스임
  • 회원이라는 개념 자체가 리소스이다
• 어떻게 리소스를 식별하는 것이 좋을까?
  • 회원을 등록하고 수정하고 조회하는 것을 모두 배제하고
  • 회원이라는 리소스만 식별하면 된다 -> 회원 리소스를 URI에 매핑해야 한다

리소스 식별, URI 계층 구조를 활용해보자

• 회원 목록 조회
  • /members
• 회원 조회
  • /members/{id}
• 회원 등록
  • /members/{id}
• 회원 수정
  • /members/{id}
• 회원 삭제
  • /members/{id}
• 조회, 등록, 수정, 삭제를 어떻게 구분할까?

리소스와 행위를 분리

• 가장 중요한 것은 리소스를 식별하는 것이라고 했다.
• URI는 리소스만 식별한다
• 리소스와 해당 리소스를 대상으로 하는 행위를 분리해야 한다
  • 리소스: 회원
  • 행위: 조회, 등록, 삭제, 변경
• 리소스는 명사, 행위는 동사 (미네랄을 캐라)
• 그러면 행위(메서드)는 어떻게 구분해야 하나?
  • HTTP 메서드가 이 역할을 대신해준다.

HTTP 메서드 - GET, POST

• HTTP 메서드: 클라이언트가 서버에 요청할 때 기대하는 행동

HTTP 메서드 종류

주요 메서드

• GET: 리소스 조회
• POST: 요청 데이터 처리, 주로 등록에 사용
• PUT: 리소스를 대체, 해당 리소스가 없으면 생성
• PATCH: 리소스 부분 변경
• DELETE: 리소스 삭제
• 참고) 최근 HTTP 스펙에서는 "리소스"가 "Representation"으로 바뀌었다고 한다

기타 메서드

• HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
• OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
• CONNECT: 대상 리소스로 식별되는 서버에 대한 터널을 설정
• TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
• CONNECT와 TRACE는 거의 쓰이지 않는다고 함

GET

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

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

리소스 조회 과정

메시지 전달

 

서버 도착

 

응답 데이터

POST

• 요청 데이터 처리
  • 요청 데이터를 처리해달라고 클라이언트에서 서버로 요청 데이터를 전달한다
• 메시지 바디를 통해 서버로 요청 데이터 전달
• 서버는 요청 데이터를 처리
  • 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
    • 이 기능들은 미리 약속되어 있다
• 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용

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

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

리소스 등록 과정

메시지 전달

 

신규 리소스 생성

• 미리 약속이 되어있다.
  • ex) 클라이언트에서 /members로 POST가 오면, 그 데이터를 저장하거나 내부적인 프로세스를 처리하는데 사용할거야
  • 여기서는 신규 등록으로 가정
• 데이터베이스에 등록 후 신규 ID(식별자)를 만든다
• 신규로 리소스가 생성되면 HTTP 201 Created라고 보낸다 (200으로 보내도 됨)
  • 201로 보낼 때는 리소스가 생성된 경로를 보내준다

응답 데이터

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

• 스펙: POST 메서드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청합니다. (구글 번역)
• 예를 들어 POST는 다음과 같은 기능에 사용됩니다.
  • HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
    • 예) HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용
• 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
  • 예) 게시판 글쓰기, 댓글 달기
• 서버가 아직 식별하지 않은 새 리소스 생성
  • 예) 신규 주문 생성
• 기존 자원에 데이터 추가
  • 예) 한 문서 끝에 내용 추가하기
• 정리: 이 리소스 URI(ex. /members)에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함 -> 정해진 것이 없음

정리

• 1. 새 리소스 생성(등록)
  • 서버가 아직 식별하지 않은 새 리소스 생성
• 2. 요청 데이터 처리
  • 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
  • 예) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
  • POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
  • 예) POST /orders/{orderId}/start-delivery (컨트롤 URI)
    • URI를 리소스 단위로 어쩔 수 없이 설계하지 못하는 경우가 있음
      • 위 예시에서 start-delivery는 리소스가 아님. (명사가 아니라 동사)
        • 이러한 URI를 컨트롤 URI라고 한다
• 3. 다른 메서드로 처리하기 애매한 경우
  • 예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
    • JSON을 바디에 넣어서 전달하고 싶은데 GET 메서드의 바디에 데이터를 넣는 것을 지원하지 않아서 넣지 못하는 경우임
    • 이런 경우에는 조회이지만 POST를 사용해야 한다. http 바디에 조회 데이터를 넘기면 된다
    • 서버로는 POST로 왔지만 필요한 값을 만들어서 응답해준다
• 애매하면 POST
  • POST는 메시지를 내부에 담아서 보내는 모든 걸 할 수 있다. 하지만 조회할 때는 GET을 사용하는게 좋다
    • GET에서는 캐싱을 하기 때문
    • 어쩔 수 없는 경우에는 POST를 사용하자

HTTP 메서드 - PUT, PATCH, DELETE

PUT

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

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

• 리소스를 대체
  • 리소스가 있으면 대체
  • 리소스가 없으면 생성
  • 쉽게 이야기해서 덮어버림
    • 비유) 폴더에 파일을 복사할 때, 폴더에 파일이 없으면 파일이 새로 생긴다. 하지만 기존에 똑같은 파일이 있으면 덮어쓸 수 있다.
    • ex) /members/100 리소스가 없으면 새로 생기고, 있으면 기존 데이터를 완전히 덮어쓴다
• 중요! 클라이언트가 리소스를 식별
  • 클라이언트가 리소스 위치를 알고 URI 지정
    • ex) http message에서 클라이언트가 /members/100 전체 위치를 알고 있다
  • POST와 차이점
    • ex) POST의 경우 /members로 요청했다. 100번에 만들어질지, 200번에 만들어질지를 알 수 없다.
    • ex) PUT은 100번에 넣을거라고 지정한다

리소스가 있는 경우

• 리소스 대체

리소스가 없는 경우

• 신규 리소스 생성

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

 

• 나이만 update하고 싶어도, 기존 리소스를 완전히 지우고 새로 생긴다
• 부분만 변경하고 싶다면? --> PATCH

PATCH

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

{
"age": 50
}

• 리소스 부분 변경
  • PATCH가 지원되지 않는다면 POST를 사용하자. POST는 무적이다

리소스 부분 변경 과정

 

DELETE

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

• 리소스 제거

리소스 제거 과정

 

HTTP 메서드를 이렇게 나눈 이유?

• POST가 거의 무적의 기능인데, 왜 GET, POST, PUT, PATCH, DELETE로 나눴을까?
  • HTTP 메서드의 속성을 통해 알아보자

HTTP 메서드의 속성

• 안전(Safe Methods)
• 멱등(Idempotent Methods)
• 캐시가능(Cacheable Methods)

• 위 표에서 GET메서드에 요청 body가 없다고 나와있지만, 이제는 body에 데이터를 넣을 수 있다.

안전(Safe)

• 호출해도 리소스를 변경하지 않는다.
  • ex) GET은 조회만 하기 때문에 안전하다. POST, DELETE, PUT, PATCH는 모두 안전하지 않다
• Q: 그래도 계속 호출해서, 로그 같은게 쌓여서 장애가 발생하면요?
• A: 안전은 해당 리소스만 고려한다. 그런 부분까지 고려하지 않는다.

멱등(Idempotent)

• f(f(x)) = f(x)
• 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.
• 멱등 메서드
  • GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
  • PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
    • ex) 똑같은 파일을 여러 번 업로드 해도 결과는 똑같다. PUT은 기존 데이터를 날리고 완전히 덮어버리기 때문
  • DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
    • 리소스를 한 번 삭제하면 리소스가 존재하지 않게 되고, 100번 삭제 해도 리소스는 존재하지 않는다
  • POST: 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
    • ex) 송금을 한 번하는 것과 두 번하는 것은 결과가 다르다
• 활용
  • 자동 복구 메커니즘
  • 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가? 판단 근거
    • ex) DELETE를 했는데 서버에서 응답이 없다면, 클라이언트가 다시 DELETE를 재시도 해도 문제가 없다
• Q: 재요청 중간에 다른 곳에서 리소스를 변경해버리면?
  • 사용자1: GET -> username:A, age:20
  • 사용자2: PUT -> username:A, age:30
  • 사용자1: GET -> username:A, age:30 -> 사용자2의 영향으로 바뀐 데이터 조회
• A: 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지는 않는다.

캐시가능(Cacheable)

• "응답 결과 리소스"를 캐시해서 사용해도 되는가?
  • ex) 웹 브라우저가 이미지를 저장하고 있을 수 있는지/없는지?
• GET, HEAD, POST, PATCH 캐시가능
• 실제로는 GET, HEAD 정도만 캐시로 사용
  • 캐시를 하려면 Resource Key가 일치해야 하는데, POST, PATCH는 바디에 데이터를 보내기 때문에 본문 내용까지 캐시 키로 고려해야 한다. --> 구현이 쉽지 않음
  • ex) GET은 URL만 가지고 캐싱을 하면 되기 때문에 간단하다
  • 실무에서는 GET만 캐싱을 사용한다고 보면 된다

 

Ref) 모든 개발자를 위한 HTTP 웹 기본 지식 - 인프런, 김영한 강의