HTTP API 설계

POST

• 클라이언트는 등록될 리소스의 URI를 모름
  • 회원등록 : POST /members
• 서버가 새로 등록된 리소스 URI를 생성해준다.
  • HTTP/1.1 201 Created
  • Location: /members/100
• POST 기반의 등록을 컬렉션(Collection)이라고 한다.
  • 서버가 관리하는 리소스 디렉터리
  • 서버가 리소스의 URI를 생성하고 관리
  • 여기서 컬렉션은 /members

 

PUT

• 클라이언트가 리소스 URI를 알고 있어야 한다.
  • 파일등록 : PUT /files/star.jpg
• 클라이언트가 직접 리소스의 URI를 지정한다.
• PUT 기반의 등록을 스토어(Store)라고 한다.
  • 클라이언트가 관리하는 리소스 저장소
  • 클라이언트가 리소스의 URI를 알고 관히
  • 여기서 스토어는 /files

 

HTTP API 다양한 시스템 연동

• 주로 JSON 형태로 데이터 통신
• UI 클라이언트 접점
  • 앱 클라이언트(아이폰, 안드로이드, PC 앱)
  • 웹 브라우저에서 자바스크립트를 통한 HTTP API 호출
  • React, Vue.js 같은 웹클라이언트
• 서버 to 서버
  • 주문 서버 -> 결제 서버
  • 기업 간 데이터 통신

HTTP API - 컬렉션

• POST 기반 등록
• 서버가 리소스 URI 결정

HTTP API - 스토어

• PUT 기반 등록
• 클라이언트가 리소스 URI 결정

HTML FORM 사용

• 순수 HTML + HTML form 사용
• GET, POST만 지원

 

참고하면 좋은 URI 설계 개념

 

문서(document)

• 단일 개념(파일 하나, 객체 인스턴스, 데이터베이스 row)
• ex) /members/100, files/star.jpg

컬렉션(collection)

• 서버가 관리하는 리소스 디렉터리
• 서버가 리소스의 URI를 생성하고 관리
• ex) /members

스토어(store)

• 클라이언트가 관리하는 자원 저장소
• 클라이언트가 리소스의 URI를 알고 관리
• ex) /files

컨트롤러(controller), 컨트롤 URI

• 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행
• 동사를 직접 사용
• ex) /members/{id}/delete