[Network] 간단히 정리한 RESTful API 설계와 URI

REST란?
Representational State Transfer
자원(URI), 행위(HTTP Method), 표현(Representations)으로 구성

RESTful API 설계

1. URI는 자원을 표시해야 한다.
2. 자원에 대한 행위는 HTTP Method로 표현해야 한다. (URI내에 Method를 포함하면 안 된다.)

 

URI 설계 원칙

1. 1. 후행 슬래쉬(/)는 URI에 포함하지 않는다.
2. 계층 관계를 나타낼 때 슬래쉬 구분자를 사용해야 한다.
3. URI의 가독성을 높이기 위해 하이픈(-) 문자를 사용해야 한다.
4. 언더바(_) 문자는 URI에 사용하지 않는다.
5. URI를 작성하는 데에는 소문자가 적합하다.
6. 파일 확장자는 URI에 포함하지 않는다.
7. 전달하고자 하는 자원의 명사를 사용하되, 컨트롤 리소스(자원을 컨트롤하기 위한 리소스)를 의미하는 경우 예외적으로 동사를 허용한다.
8. URI에 작성되는 영어는 복수형으로 작성한다.
9. Paging 또는 Filter 기능(검색 범위를 제한 Ex. level=1)을 사용할 때, Query String을 사용한다.

 

 

 

 

 

참고 출처

[번역글] REST API URI를 결정하는 7가지 규칙

REST API URI 규칙

[web 01] RESTful API 적용하기