HTTP API 설계 예시

HTTP API 설계

 

예1) 회원 관리 시스템 - POST 기반

 

-> 서버가 리소스를 관리함

-> Collection

-> 실무는 대부분 POST기반 관리함

 

예2) 파일 관리 시스템 - PUT 기반

파일 목록 /files -> GET

파일 조회 /files/{filename} -> GET

파일 등록 /files/{filename} -> PUT

파일 삭제 /files/{filename} -> DELETE

 

-> 클라이언트가 리소스를 알고있고 관리함

-> Store

 

 

예3) 리소스만으로 설계할 수 없는 경우

(실무 대부분임)

/order/updateStatus

/order/updateDelivery

-> 동사를 사용하여 하나의 리소스에서 하나의 uri로만 할 수 없는 경우

-> controller

 

 

출처 : <모든 개발자를 위한 HTTP 웹 기본지식> BY. 김영한