[REST] 리소스

REST의 네이밍은 개발자가 다루는 리소스(resource)를 기준으로 한다. 문서나 이미지 등과 같이 어떠한 데이터도 네이밍에 사용되는 리소스로 활용될 수 있다. 

 

리소스 데이터는 싱글턴 또는 컬렉션으로 존재할 수 있다.

 

즉 단수 혹은 복수로 표현될 수 있다.

 

users
// is a collection resource

user
// is a singleton resource

 

싱글턴과 컬렉션 리소스의 표현 방식을 살펴보자.

 

리소스는 하위 컬렉션을 포함할 수 있다.

 

예를 들어 다양한 명품 브랜드가 입접된 온라인 명품 편집샵 서비스가 있다고 가정해보자. 특정 브랜드(brand)의 하위 컬렉션 리소스인 제품(products)은 URN로 다음과 같이 표현될 수 있다.

 

/brands/{brandId}/products

 

싱글턴의 경우, 하위 컬렉션 제품(products)의 싱글턴 리소스인 단일 제품(product)는 다음과 같이 표현될 수 있다.

여러개 중 특정 하나를 표현하는 것이다.

 

/brands/{brandId}/products/{productId}

 

URI

 

REST API는 URI를 통해 리소스 주소를 표기한다. REST 방식의 URI는 직관적이고 이해하기 쉬워야 한다. 

 

참고

https://restfulapi.net/resource-naming/

REST Resource Naming Guide