API URI
URI (Uniform Resource Identifier)
리소스 식별
리소스 : 회원이라는 개념
ex) 미네랄을 캐라 -> 미네랄이 리소스
어떻게 식별하면 좋은가.
회원을 등록, 수정, 조회하는 것을 모두 배제
회원이라는 리소스만 식별하면 됨. (회원 리소스를 URI에 매핑)
API URI 설계
회원 목록 조회 / 회원 조회 / 회원 등록 / 회원 수정 / 회원 삭제
*계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장 ( member보다는 members )
ex)
회원 목록 조회/members/{id}
회원 조회/members/{id}
회원 등록/members/{id}
회원 수정/members/{id}
회원 삭제/members/{id}
URI는 리소스만 식별한다.
리소스와 행위 분리
리소스 : 회원(명사)
행위 : 조회, 등록, 삭제, 변경(동사, 미네랄을 캐라)
메소드 종류
GET : 리소스 조회
POST : 요청 데이터 처리, 주로 등록 사용
PUT : 리소스 대체, 해당 리소스 없으면 생성
PATCH : 리소스 부분 변경
(기타 / 알아두기만 하자)
HEAD : GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
OPTIONS : 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명 (주로 CORS에서 사용)
*CORS : Cross-Origin Resource Sharing 교차 출처 리소스 공유
GET
리소스 조회
GET /search?q=hello&hi=ko HTTP/1.1
HOST: www.google.com서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달
메시지 바디를 사용해서 데이터를 전달할 수 있으나, 권장 x
POST
요청 데이터 처리
메시지 바디를 통해 서버로 요청 데이터 전달
서버는 요청 데이터를 처리
- 메시지 바디를 통해 들어온 데이터 처리의 모든 기능 수행
주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
POST /members HTTP/1.1
Content-Type : application/json
{
"username" : "hello",
"age" : 20
}
요청 데이터 처리 순서
- 스펙 : POST 메서드는 대상 리소스가 리소스의 고유 한 의미 체계에 따라 요청에 포함 된 표현을 처리하도록 요청
- 이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 한다. -> 정해진 것이 없다.
POST
1. 새 리소스 생성(등록)
- 서버가 아직 식별하지 않은 새 리소스 생성
- 요청 데이터 처리
- 단순 데이터 생성 및 변경을 넘어서 프로세스 처리해야 하는 경우
예) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우- POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
예) POST /orders/{orderID}/start-delivery (컨트롤 URI)
- 다른 메소드로 처리하기 애매한 경우
예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
애매하면 POST
PUT
리소스 대체
- 리소스가 있으면 대체 / 없으면 생성 -> 덮는 역할
클라이언트가 리소스 식별 - 클라이언트가 리소스 위치 알고 URI 지정
- POST와 차이점
PUT /members/100 HTTP/1.1
Content-Type : application/json
{
"username" : "hello",
"age" : 20
//username 없으면 기존 데이터에서 username 사라짐
}PATCH
리소스 부분 변경
PATCH /members/100 HTTP/1.1
Content-Type : application/json
{
"age" 50
//username 없어도 기존 username 보존
}DELETE
리소스 제거
DELETE /members/100 HTTP/1.1
Host : localhost:8080HTTP 메서드의 속성
안전(Safe Methods)
멱등(Idempotent Methods)
캐쉬가능(Cacheable Methods)
