[네트워크] REST API

RESPT API란 REST의 원리를 따르는 API를 의미한다.

하지만 REST API를 올바르게 설계하기 위해서는 지켜야 하는 몇가지 규칙이 있다.

 

 

REST API 설계 예시

1. URI는 동사보다는 명사를, 대문자보다는 소문자를 사용하여야 한다.

Bad Example http://studybloghcs.com/Running/
Good Example  http://studybloghcs.com/run/  

 

2. 마지막에 슬래시 (/)를 포함하지 않는다.

Bad Example http://studybloghcs.com/test/  
Good Example  http://studybloghcs.com/test

 

3. 언더바 대신 하이폰을 사용한다.

Bad Example http://studybloghcs.com/test_blog
Good Example  http://studybloghcs.com/test-blog  

 

4. 파일확장자는 URI에 포함하지 않는다.

Bad Example http://studybloghcs.com/photo.jpg  
Good Example  http://studybloghcs.com/photo  

 

5. 행위를 포함하지 않는다.

Bad Example http://studybloghcs.com/delete-post/1  
Good Example  http://studybloghcs.com/post/1  

 

 

 

RESTFUL

REST의 원리를 따르는 시스템을 의미한다. 하지만 REST를 사용했다 하여 모두가 RESTful 한 것은 아니다.  REST API의 설계 규칙을 올바르게 지킨 시스템을 RESTful하다 말할 수 있으며, 모든 CRUD 기능을 POST로 처리 하는 API 혹은 URI 규칙을 올바르게 지키지 않은 API 혹은 REST API의 설계 규칙을 올바르게 지키지 못한 시스템은 REST API를 사용하였지만 RESTful 하지 못한 시스템이라고 할 수 있다.