[HTTP] 메서드

HTTP API 생성

요구사항 - 회원 정보 관리 API

 

1. API URI(Uniform Resource Identifier) 설계

 

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

 

• 회원을 등록하고 수정하고 조회하는게 리소스가 아님 -> 모두 배제
• 회원이라는 개념 자체가 리소스. 리소스만 식별 -> 회원 리소스를 URI에 매핑
• URI는 리소스만 식별 -> 리소스와 해당 리소스를 대상으로 하는 행위를 분리
• 리소스(명사) - 회원, 행위(동사) - 조회, 등록, 삭제, 변경

 

• 회원 목록 조회 /members
• 회원 조회 /members/{id}
• 회원 등록 /members/{id}
• 회원 수정 /members/{id}
• 회원 삭제 /members/{id}

 

---

HTTP 메서드

 

GET

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

• 리소스 조회 - 메시지 전달 -> 서버 도착 -> 응답
• 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)을 통해서 전달
• 메시지 바디를 사용해 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아 권장 x

 

POST

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

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

 

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

 

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

2. 요청 데이터 처리

 

• 단순히 데이터를 생성, 변경하는 것을 넘어서 프로세스를 처리해야하는 경우
• 메시지 바디를 통해 서버로 요청 데이터 전달
• 서버는 요청 데이터를 처리 -> 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행

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

 

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

 

PUT

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

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

• 리소스를 대체(덮음), 해당 리소스가 없으면 생성
• 클라이언트가 리소스 위치를 알고 URI 지정함(리소스 식별) -> POST와의 차이점 

 

PATCH

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

{
    "age": 50
}

• 리소스 부분 변경

 

DELETE

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

• 리소스 제거

 

기타 메서드

 

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

 

---

HTTP 메서드의 속성

 

안전(Safe Methods)

 

• 호출해도 리소스를 변경하지 않음
• 안전은 해당 리소스만 고려함. 계속 호출해서 로그가 쌓여 발생하는 장애와 같은 것은 고려 x
• ex) 단순 조회인 GET은 안전하지만, POST와 같이 변경이 일어나면 안전하지 않음

 

멱등(Idempotent Methods)

 

• 한 번 호출하든 두 번 호출하든 결과가 똑같음
• 똑같은 메시지를 요청했을 때 최종 결과가 같음
• 멱등 메서드: GET, PUT, DELETE
• POST는 멱등이 아님 ex) 같은 결제를 두 번 하면 중복 결제 가능
• 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려  x
• 활용
  • 자동 복구 메커니즘
  • 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는지 판단 근거가 됨

 

캐시가능(Cacheable Methods)

 

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