본문 바로가기

우아한테크코스

api 설계

리소스 타입(resource archetypes)별 표현

  • document
  • collection
  • store
  • controller

Document

  • 객체 인스터스와 유사한 단일 개념
  • 단수개의 리소스를 표현

/resources/{id} /resources/{id}/sub-resources/{id}

Collection

  • 리소스의 디렉토리를 의밈
  • 복수를 사용하여 표현

/resources /resources/{id}/sub-resources

Store

  • 서버가 아닌 클라이언트가 관리하는 리소스
  • document와의 차이는 고유식별자가 없음
  • 복수를 사용하여 표현

/resources/{id}/path

Controller

  • 절차라는 개념의 리소스
  • 실행가능한 함수와 유사
  • 매개 변수와 반환 값이 존재
  • 동사를 사용해도 좋음

/resources/{id}/checkout /resources/{id}/sub-resources/{id}/play

반응형