API URI 설계
URI (Uniform Resource Identifier)
리소스를 식별해서 설계해야 한다.
잘못된 예)
회원 목록 조회 /read-member-list
회원 조회 /read-member-by-id
회원 등록 /create-member
회원 수정 /update-member
회원 삭제 /delete-member잘된 예)
회원 목록 조회 /members
회원 조회 /members/{id}
회원 등록 /members/{id}
회원 수정 /members/{id}
회원 삭제 /members/{id}» 리소스 식별, URI 계층 구조 활용
리소스와 행위를 분리하여 행위는 메서드에게 위임
HTTP 메서드
주요 메서드
- GET: 리소스 조회
- POST: 요청 데이터 처리, 주로 등록에 사용
- PUT: 리소스를 대체, 해당 리소스가 없으면 생성
- PATCH: 리소스 부분 변경
- DELETE: 리소스 삭제
기타 메서드
- HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
- OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
- CONNECT: 대상 자원으로 식별되는 서버에 대한 터널을 설정
- TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
♦ GET (리소스 조회)
GET /search?q=hello&hl=ko HTTP/1.1
Host: www.google.com
서버에 전달하고 싶은 데이터는 query를 통해서 전달
(메시지 바디를 사용해서 데이터를 전달할 수 있지만 권장하지 않음)
♦ POST (요청 데이터 처리)
POST /members HTTP/1.1
Content-Type: application/json
{
"username": "hello",
"age": 20
}
- 메세지 바디를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리
- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
메세지 바디에 데이터를 담아 전송
신규 리소스 식별자를 추가하고 메세지 바디에 담겨온 데이터를 등록
신규등록시 201 코드 전송과 함께 Location도 같이 전달
POST 사용 예)
데이터 블록을 데이터 처리 프로세스에 제공 (HTML form에 입력한 정보로 회원 가입)
서버가 아직 식별하지 않은 새 리소스 생성 (신규 주문 생성)
기존 자원에 데이터 추가 (문서 끝에 내용 추가)
리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함
POST 정리
-
새 리소스 생성(등록)
서버가 아직 식별하지 않은 새 리소스 생성 -
요청 데이터 처리
단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
예) POST /orders/{orderId}/start-delivery (컨트롤 URI) -
다른 메서드로 처리하기 애매한 경우
예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우 애매하면 POST
♦ PUT(리소스를 대체)
PUT /members/100 HTTP/1.1
Content-Type: application/json
{
"username": "hello",
"age": 20
}
리소스가 있으면 대체 / 리소스가 없으면 생성 (덮어버림)
클라이언트가 리소스 위치를 알고 URI 지정 (POST와 차이점)
| 기존에 리소스가 있는 경우 ⇒ 리소스 대체
| 기존에 리소스가 없는 경우 ⇒ 신규 리소스 생성
!!주의!!
리소스를 아예 대체 하므로 부분 변경은 다른 메서드(PATCH)를 사용
♦ PATCH (리소스 부분 변경)
PATCH /members/100 HTTP/1.1
Content-Type: application/json
{
"age": 50
}
♦ DELETE (리소스 제거)
DELETE /members/100 HTTP/1.1
Host: localhost:8080
HTTP 메서드의 속성
- 안전(Safe Methods)
- 멱등(Idempotent Methods)
- 캐시가능(Cacheable Methods)
안전 (Safe)
- 호출해도 리소스를 변경하지 않는다.
멱등 (Idempotent)
- 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.
- GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
- PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
- DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
- POST: 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
- 활용 : 자동 복구 메커니즘 판단 근거
(서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시해도 되는가?)
멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지는 않는다.
캐시가능 (Cacheable)
- 응답 결과 리소스를 캐시해서 사용해도 되는가?
- GET, HEAD, POST, PATCH 캐시가능
- 실제로는 GET, HEAD 정도만 캐시로 사용
- POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않음
스터디 문제
API를 설계할 때, 리소스와 행위를 분리하여 리소스는 _ _ , 행위는 _ _에게 위임
각각 맞는 메서드 이름을 쓰세요.
_: 리소스 조회
_: 요청 데이터 처리, 주로 등록에 사용
_: 리소스를 대체, 해당 리소스가 없으면 생성
_: 리소스 부분 변경
_: 리소스 삭제
메서드 속성이 ‘안전'한 메서드는 무엇이 있나요?
