REST API 디자인 가이드

REST API를 어떻게 설계하는지는 회사마다 다를 것이다. 하지만 권장하는 방법은 분명 존재하며, 좋은 REST API를 사용자들에게 제공할 수 있도록 디자인 방식에 대해서 공부해보자.

1. REST는 간략하고 직관적이게 디자인한다.

REST API는 URL만 보고 URL이 의미하는 바를 알 수 있어야 한다.
REST API는 길게 만들기 보다 짧게 만들어 제공하자. ( 최대 2 Depth를 권장 )
URL은 될 수 있으면 명사를 사용하자.
- URL 작성되는 내용은 리소스 정보를 다루고 있기 때문에 동사보다 명사가 더욱 어울린다. 단, 명사를 사용하게 되면 단수 보다는 복수형을 사용하자. 의미상 복수형이 더욱 어울리는 표현이기 때문이다.

[잘못된 예: HTTP Post로 정의하고 get/set을 URL에 명시함으로서 행위를 구분하고자 하였다]   
HTTP Post : /getDevices   
HTTP Post : /setDevices   

[올바른 예]   
HTTP Get  :  /devices   
HTTP Post : /devices/{cleaner}

리소스에 대한 행위는 HTTP에 Method를 통해 표현하는 것이 올바르다

[디자인 가이드]   
1> create     
		1-1> HTTP POST /devices                 ------> devices 생성       
		1-2> HTTP POST /devices/cleaner    ------> 에러    
2> read      
		2-1> HTTP GET /devices                   ------> 모든 devices 정보 조회       
		2-2> HTTP GET /devices/cleaner      ------> cleaner 정보 조회    
3> update      
		3-1> HTTP PUT /devices                   ------> 모든 devices 업데이트        
		3-2> HTTP PUT /devices/cleaner      ------> cleaner 정보 업데이트     
4> delete      
		4-1> HTTP DELETE /devices             ------> 모든 devices 삭제      
		4-2> HTTP DELETE /devices/cleaner ------> cleaner 삭제

REST API 디자인 가이드

1. REST는 간략하고 직관적이게 디자인한다.

2. 리소스간에 관계를 표현하는 방법을 적용하자