REST API URI 설계규칙

REST API?

REST API(RESTful API)는 REST(REpresentational State Transfer) 아키텍처의 제약조건을 준수하는 API(Application Programming Interface)이다.

시스템과 상호작용해 정보를 검색하거나 기능을 수행하고자할 때 원하는 것을 전달할 수 있게 지원해 요청을 이행하도록 함.

즉 HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고 HTTP Methods(POST, GET, PUT, DELETE)를 통해 자원에 대한 CRUD(Create, Read, Update, Delete) 연산을 적용하는 것이다.

RESTful API 설계 규칙

1. 소문자 사용

ex) /firstExample (X)
/first-example (O)

2. 하이픈(-) 사용

ex) /first_example (X)
/first-example (O)

3. 마지막에는 슬래시(/) NO

ex) /hello/ (X)
/hello (O)
두 URI는 동등하게 취급되지만 서로 다른 자원에 매핑되므로 '/' 를 끝에 붙이면 안됨!

4. 명사 사용

ex) /get-students (X)
/students (O)
예외적으로 컨트롤 자원을 의미할 땐 동사를 허용함
ex) /writing (X)
/write (O)

5. 파일 확장자 표시 NO

ex) /students/list.json (X)
/students/list (O)
Content-Type이나 Accept Header 사용

6. 복수형 사용

ex) /student (X)
/students (O)

7. 계층관계는 슬래시(/)로 구분