URI 설계
URI 설계할 때 리소스 식별에 의미를 두어야 한다.
행위는 배제하고 리소스만 식별하면 된다.
예시) 회원의 조회, 등록, 삭제, 변경
리소스에 매칭하여 URI를 설계했을 경우 -> 행위(메서드) 구분의 필요성
회원 조회 /members/{id}
회원 등록 /members/{id}
회원 수정 /members/{id}
회원 삭제 /members/{id}
리소스와 행위를 분리
URI는 리소스만 식별한다.
리소스와 해당 리소스를 대상으로 하는 행위를 분리하여 설계한다.
- 리소스: 회원
- 행위: 조회, 등록, 삭제, 변경
HTTP 메서드 종류
주요 메서드
- GET 리소스 조회
- POST 요청 데리터 처리, 주로 등록에 사용
데이터를 담아서 클라이언트에 보낼 때 - PUT 리소스를 대체, 해당 리소스가 없으면 생성
파일을 폴더에 넣는것과 비슷하다. 기존 파일이 있으면 덮고 없으면 생성한다. - PATCH 리소스 부분 변경
회원의 이름을 바꾸거나 특정 컬럼을 바꿀 때 사용 - DELETE 리소스 삭제
기타 메서드
- HEAD
- OPTIONS
- CONNECT
- TRACE
GET
리소스 조회할 때 사용한다.
*요청 메세지 예시(클라이언트 -> 서버)
GET /search?q=hello HTTP/1.1
Host: www.google.com
*응답 메세지 예시(서버 -> 클라이언트)
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 34
{
"username":"young",
"age":20
}GET 특징
- 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달한다.
- 메세지 바디를 통해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않는다.
클라이언트에서서버로요청 메세지를 보내고,서버는응답 메세지를 만들어서클라이언트에게 보낸다.
POST
요청 데이터를 처리할 때 사용한다.
대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청한다.
주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용한다.
*요청 데이터 예시(클라이언트 -> 서버)
POST /members HTTP/1.1
Content-Type:application/json
{
"username":"young",
"age":20
}
*응답 데이터 예시(서버 -> 클라이언트)
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length:34
Location:/members/100
{
"username":"young",
"age":20
}- 메세지 바디를 통해 서버로 요청 데이터를 전달한다.
- 서버는 요청 데이터를 처리한다.
- 메세지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
POST 사용 예시
- 새 리소스 생성(등록)
서버가 아직 식별하지 않은 새 리소스 생성 - 요청 데이터 처리
단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
예시) 결제 완료 -> 배달 시작 -> 배달 완료
post의 결과로 새로운 리소스가 생성되지 않을 수도 있음 - 다른 메서드로 처리하기 애매한 경우
JSON으로 조회 데이터를 넘겨야 하는데 GET 메서드를 사용하기 어려운 경우
애매하면 POST를 사용한다
PUT
리소스를 있으면 대체하고, 리소스가 없으면 생성할 때 사용한다.
클라이언트가 리소스 위치를 알고 URI를 지정한다(클라이언트가 리소스를 식별한다). -> POST와의 차이점
*리소스 위치(/members/100)까지 지정한다 -> POST와의 차이점
*/members/100의 리소스를 대체하고 싶은 경우
*요청 데이터 예시(클라이언트 -> 서버)
PUT /members/100 HTTP/1.1
Content-Type:application/json
{
"username":"young",
"age":20
}
PUT 특징
기존 리소스에서 대체할 리소스로 완전히 대체되기 때문에 주의해서 사용해야 한다.
기존 리소스: username, age
대체할 리소스: age
결과: username이 삭제됨
PATCH
리소스를 부분 변경할 때 사용한다.
HTTP 자체에서 PATCH를 지원하지 않는 경우 POST로 대체하여 사용한다.
*/members/100에서 age만 변경하고 싶은 경우
*요청 데이터 예시(클라이언트 -> 서버)
PATCH /members/100 HTTP/1.1
Content-Type:application/json
{
"age":50
}DELETE
리소스를 제거할 때 사용한다.
*/members/100의 리소스를 제거하고 싶을 경우
*요청 데이터 예시(클라이언트 -> 서버)
DELETE /members/100 HTTP/1.1
Host:localhost:8080HTTP 메서드의 속성
안전(Safe)
여러번 호출해도 리소스가 변경되지 않는 경우를 안전하다고 말한다.
멱등(Idempotent)
몇 번 호출하든 결과가 같다.
외부 요인으로 인해 중간에 리소스가 변경되는 것까지 고려하지는 않는다.
예시) 여럿이 보는 페이지에서 특정 사용자의 메소드 호출로 인한 리소스 변화
멱등 메서드
GET, PUT, DELETE
*예외: POST(두번 호출하면 같은 결제가 중복해서 발생할 수 있다.)
멱등의 활용
- 서버에서 정상응답을 못 주었을 때, 클라이언트가 같은 요청을 해도 될 때
- 자동 복구 메커니즘
예시) DELETE 호출 후 응답 없을 때 재호출 가능
캐시가능(Casheable)
응답 결과 리소스를 캐시해서 사용해도 될 때 사용한다.
캐시가능 메서드
GET, HEAD, POST, PATCH
캐시가능 활용
실제로는 GET, HEAD만 주로 사용한다.
(URL만 캐시 키로 잡고 사용하기 쉽다.)
POST, PATCH는 본문 내용까지 캐시 키로 고려해야 해서 잘 사용하지 않는다.
