HTTP 메서드

HTTP API 만들어보기

ex) 요구사항: 회원 정보 관리 API 만들기(회원 목록 조회, 회원 조회, 등록, 수정, 삭제)

API URI에서 가장 중요한 것은 리소스 식별

 

리소스?

회원을 등록하고 수정하는 것이 리소스가 아님 → 회원이라는개념 자체가 리소스

ex) 미네랄을 캐라 → 미네랄이 리소스

리소스를 어떻게 식별?

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

회원이라는 리소스만 식별하면 됨 → 회원 리소스를 URI에 매핑

 

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

회원 목록 조회 /members

회원 조회 /members/{id}

회원 등록 /members/{id}

회원 수정 /members/{id}

회원 삭제 /members/{id}

? 어떻게 구분? → 리소스와 행위를 분리

 

리소스와 행위을 분리

URI는 리소스만 식별

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

리소스: 회원

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

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

행위(메서드)는 어떻게 구분? → HTTP메서드가 구분해줌

---

HTTP 메서드 - GET, POST

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

HTTP 메서드 종류

[주요 메서드]

GET: 리소스 조회

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

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

PATCH: 리소스 부분 변경

DELETE: 리소스 삭제

[기타 메서드]

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

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

CONNECT: 대상 자원으로 식별되는 서버에 대한 터널을 설정 → 거의 사용 안함

TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행 → 거의 사용 안함

 

GET

ex)

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

• 리소스 조회
• 서버에 전달하고 싶은 데이터는 query를 통해서 전달
• 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음

 

POST

ex)

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

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

• 요청 데이터 처리
• 메시지 바디를 통해 서버로 요청 데이터 전달
• 서버는 요청 데이터를 처리
  • 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행
• 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
• 응답 데이터로 자원이 생성된 경로를 보내줌
• 스펙: POST 메서드는 대상 리소스가 리소스의 고유 한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청
  • ex) 게시판 글쓰기, 신규 생성, 기존 자원에 데이터 추가 등등
• 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함
• POST는 모든 것을 할 수 있음, 하지만 조회 부분은 최대한 GET을 사용하기!

[정리]

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

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

2. 요청 데이터 처리

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

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

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

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

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

- 애매하면 POST

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

 

---

HTTP 메서드 - PUT, PATCH, DELETE

PUT
ex)

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

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

• 리소스를 완전히 대체
  • 리소스가 있으면 대체
  • 리소스가 없으면 생성
  • → 기존에 있던 파일을 덮어버림
• 클라이언트가 리소스를 식별
  • 클라이언트가 리소스 위치를 알고 URI 지정
  • POST와 차이점

PATCH

ex)

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

{
    "age": 50
}

• 리소스 부분 변경
• PATCH가 지원이 안되는 경우에는 POST 사용

DELETE

ex)

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

• 리소스 제거

---

HTTP 메서드의 속성

안전(Safe Methods)

• 호출해도 리소스를 변경하지 않음 → 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는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않음