0419 - 0425

0420 - REST Resource Naming Guide

1. A resource can be a singleton or a collection.
   하나의 리소스는 싱글턴 또는 컬랙션이 될 수 있다.

2. A resource may contain sub-collection resources also
   리소스는 sub-collection 리소스를 포함할 수 있다.
   /customers/{Id}/accounts

REST Resource 네이밍

Use nouns to represent resources. (리소스를 표한하기 위해서 명사를 사용)
RESTful URI는 반드시 리소스 그 자체를 언급해야 하며, 리소스의 행동을 언급해서는 안된다.
예를 들면, 아래와 같은 리소스들이 있을 때 URI는 다음과 같이 디자인 될 수 있다.

• Users of the system
• User Accounts
• Network Devices etc

http://api.example.com/device-management/managed-devices 
http://api.example.com/device-management/managed-devices/{device-id} 
http://api.example.com/user-management/users/
http://api.example.com/user-management/users/{id}

1. document 리소스 문서의 유형을 나타날 때는 '단수'를 사용.

http://api.example.com/device-management/managed-devices/{device-id}
http://api.example.com/user-management/users/{id}
http://api.example.com/user-management/users/admin

2. collection 리소스 Collection 단위의 리소스를 표시할 때는 '복수'를 사용

http://api.example.com/device-management/managed-devices
http://api.example.com/user-management/users
http://api.example.com/user-management/users/{id}/accounts

3. store 리소스 저장에 관한 요청은 클라이언트가 관리하는 리소스 저장소이다. 따라서 '복수'를 사용한다

http://api.example.com/song-management/users/{id}/playlists

4. controller 리소스 컨트롤러 리소스는 실행 가능한 기능과 함께 파라미터 혹은 리턴 값으로 이름 짓는다.
   이 때는 '동사'를 사용한다.

http://api.example.com/cart-management/users/{id}/cart/checkout
http://api.example.com/song-management/users/{id}/playlist/play

URI의 일관성

1. 계층 구조를 표현하기 위해서 '/'를 사용한다.

http://api.example.com/device-management
http://api.example.com/device-management/managed-devices
http://api.example.com/device-management/managed-devices/{id}
http://api.example.com/device-management/managed-devices/{id}/scripts
http://api.example.com/device-management/managed-devices/{id}/scripts/{id}

2. 끝에 '/'가 붙지 않도록 한다.

3. 언더바 사용은 피하며 '-'을 사용한다.

4. 편리함 + 컨벤션을 시키지 위해서 소문자를 사용한다.

5. 파일 확장자를 포함 하지 않는다.

6. URI를 사용해서 CRUD 기능의 수행되었음을 표시해서는 안된다.
   URI는 자원에 대ㅑ한 어떠한 행동을 나타내면 안되고, 자원을 독립적으로 식별하는 방식으로 사용되어야 한다. 어떤 기능이 수행되는지 표시하기 위해서는 HTTP 요청 방법을 사용한다.

HTTP GET http://api.example.com/device-management/managed-devices  //Get all devices
HTTP POST http://api.example.com/device-management/managed-devices  //Create new Device

HTTP GET http://api.example.com/device-management/managed-devices/{id}  //Get device for given Id
HTTP PUT http://api.example.com/device-management/managed-devices/{id}  //Update device for given Id
HTTP DELETE http://api.example.com/device-management/managed-devices/{id}  //Delete device for given Id

7. 쿼리스트링을 이용하는 것을 고려해라
   특정 리소스의 속성을 기준으로 정렬, 필터링을 자주하게 될 수 있다. 이를 위해서 새로운 API를 만들기보단, 입력 매개변수를 쿼리스트링에 전달하도록 한다.