인프런 HTTP 강의 정리 #4

1 . HTTP API를 만들어보자

1) 요구사항

회원 정보 관리 API를 생성한다.

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

2) 리소스란?

- 회원이라는 개념 자체가 리소스!

- 회원을 등록, 수정, 조회하는 것은 리소스가 아니다.

 

3) 리소스 식별 방법

- 회원을 등록, 수정, 조회하는 것을 모두 배제한다.

- 회원이라는 리소스만 식별 -> 회원 리소스를 URI에 매핑

 

4) API URI 설계

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

그러나 위와 같이 회원이라는 리소스를 URI에 매핑하면, 회원 조회/등록/수정/삭제의 URI가 동일하여 구분할 수 없는 문제가 발생한다. 이를 해결하기 위해서는 리소스와 행위를 분리해야 한다.

 

5) 리소스와 행위 분리

   

   중요한 것은 리소스를 식별하는 것이다!

• 리소스와 해당 리소스를 대상으로 하는 행위 분리 (리소스: 회원 -> 명사 / 행위 : 조회, 등록 -> 동사)
• URI로 리소스 표현
• 리소스에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현

2 . HTTP 메서드 - GET, POST

- HTTP 주요 메서드 종류

• GET : 리소스 조회
• POST : 요청 데이터 처리 (주로 등록에 사용)
• PUT : 리소스를 대체, 해당 리소스가 없으면 생성
• PATCH : 리소스 부분 변경  ex) 회원 이름 변경
• DELETE : 리소스 삭제

1. GET

• 리소스 조회
• 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터/ 쿼리 스프링)을 통해 전달

1) 리소스 조회 1 - 메시지 전달

클라이언트가 members/100 유저를 조회하기 위해 GET 방식으로 HTTP 요청 메시지를 서버에 전달한다.

 

 

2) 리소스 조회 2 - 서버 도착

서버에 GET 메시지가 도착하면 서버는 GET 메시지를 해석하여 DB에서 /members/100 유저를 조회하여 JSON 메시지를 만든다.

 

3) 리소스 조회 3 - 응답 데이터

서버는 리소스 조회에 성공했다는 의미로 status-line에 200 OK, header에 Content-Type,

message-body에 /members/100을 조회한 결과(JSON)을 붙여 HTTP 응답 메시지를 만든다.

 

 

2 . POST

• 요청 데이터 처리
• 메시지 바디를 통해 서버로 요청 데이터 전달
• 서버는 요청 데이터 처리

1) 리소스 조회 1 - 메시지 전달

클라이언트가 유저를 등록하기 위해  message-body에 유저 데이터를 담아서 POST 방식으로 HTTP 요청 메시지를 서버에 전달한다. (POST로 /members에 요청이 들어오면 서버는 데이터를 저장한다는 것을 미리 약속한다)

 

2) 리소스 조회 2 - 서버 도착

서버에 POST 메시지가 도착하면 서버는 POST 메시지를 해석하여 DB에 데이터를 등록하고 신규 리소스 식별자를 생성한다.

 

3) 리소스 조회 3 - 응답 데이터

서버는 데이터 등록을 성공했다는 의미로 status-line에 201 Created, header에 Location: 리소스가 생성된 신규 URI 경로(/members/100), message-body에 등록된 리소스(JSON)을 붙여 HTTP 응답 메시지를 만든다.

 

POST 메서드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청한다.

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

 

- POST 정리

• 새 리소스 생성(등록) : 서버가 아직 식별하지 않은 새 리소스 생성
• 요청 데이터 처리 : 프로세스 처리   ex) 결제완료 -> 배달 시작 -> 배달 완료
• 다른 메서드로 처리하기 애매한 경우

-> 데이터를 조회할 때는 최대한 GET을 쓰고, 그 외에 데이터가 변경되거나 프로세스가 진행되거나 어쩔 수 없는 경우 POST를 쓴다.

 

3 . HTTP 메서드 - PUT, PATCH, DELETE

1. PUT

• 리소스가 있으면 대체(덮어씀)
• 리소스가 없으면 생성
• 클라이언트가 리소스 식별
• 클라이언트가 리소스 위치를 알고 URI 지정 (POST와 차이점)  ex) PUT : /members/100

1) 리소스가 있는 경우

클라이언트가 /members/100에 리소스를 대체하기 위해 PUT 방식으로 HTTP 요청 메시지를 서버에 보낸다.

 

 

서버에 /members/100이 있으면, HTTP 요청 메시지의 message-body에 있는 데이터로 리소스가 대체된다.

 

2) 리소스가 없는 경우

클라이언트가 /members/100에 리소스를 대체하기 위해 PUT 방식으로 HTTP 요청 메시지를 서버에 보낸다.

 

서버에 /members/100 이 있으면, HTTP 요청 메시지의 message-body에 있는 데이터로 신규 리소스가 생성된다.

 

3) PUT은 리소스를 완전히 대체

age의 값만 변경하기 위해 message-body에 username은 빼고 변경할 age 값만 담아서 보낸다.

 

리소스를 덮어쓰기 때문에, message-body에 있는 age 값만 들어가고 username 필드가 삭제된다.

 

2. PATCH

   - 리소스 부분 변경

 

age의 값만 변경하기 위해 message-body에 username은 빼고 변경할 age 값만 담아서 보낸다.

 

리소스를 부분 변경하기 때문에, message-body에 있는 age 값만 변경된다.

 

3. DELETE

   - 리소스 제거

 

클라이언트가 /members/100에 있는 리소스를 삭제하기 위해 서버에 DELETE 방식으로 HTTP 요청 메시지를 보낸다.

 

서버는 /members/100에 있는 리소스를 제거한다.

 

4 . HTTP 매서드의 속성

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

 

1) 안전 (Safe)

  - 호출해도 리소스 변경 x

  - 안전은 해당 리소스만 고려하며, 호출 반복 시 발생 가능한 장애는 고려 x

 

2) 멱등 (Idempotent)

  - 클라이언트가 서버에 같은 요청을 여러 번 해도 결과도 똑같다.

• GET :  몇 번을 조회하든 같은 결과가 조회된다.
• PUT : 결과를 대체한다. 따라서 같은 요청을 여러 번 해도 대체된 결과는 같다.
• DELETE : 결과를 삭제한다. 따라서 같은 요청을 여러 번 해도 삭제된 결과는 같다.

단, POST는 멱등이 아니다. 같은 데이터를 계속 POST로 전송하면 서버에서 매번 새로운 리소스를 생성한다.

 ex) 두 번 호출하면 같은 결제가 중복해서 발생 가능

 

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

 

3) 캐시가능 (Cacheable)

• 로컬 PC에 웹 브라우저가 리소스를 저장하고, 이후에 같은 요청이 들어오면 서버에 요청을 하지 않는다.
• 캐시는 원본 데이터가 변경되지 않고 유지되어야 한다.
• 캐시 가능 : GET, HEAD, POST, PATCH 
• 실제로는 GET, HEAD 정도만 캐시로 사용
• POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 어려움