앞서 REST API란 REST한 인터페이스라고 알아봤다.
이 REST란 인터페이스를 작성할때의 규칙을 알아보자.
https://standout.tistory.com/1076
REST와 REST API, 그리고 RESTful
REST Representational State Transfer HTTP 프로토콜을 기반으로 자원을 정의하고 상태를 주고받는 방식 https://standout.tistory.com/606 REST란? REST란? Representational State Transfer의 약자 하나의 URI가 고유한 리소스를
standout.tistory.com
URI는 관계가 있는 /정보/자원을 표시한다
/구분자는 계층관계에 사용된다.
예를들어, 사용자 중에 특정 ID를 가진 사용자의 관심목록 중 기기데이터를 뽑아낸다고 가정했을때의 URI는 아래와같다.
/리소스명/리소스 ID/관계가 있는 다른 리소스명
GET : /users/{userid}/likes/devices
URI의 마지막 문자로 /를 포함하지않는다.
http://restapi.example.com/houses/apartments/ (X)
URI는 소문자가 적합하다.
대소문자에 따라 다른 리소스로 인식하게 되기 때문이다.
POST http://api.test.com/users/1/boardPost/1 (X)
URI에 파일확장자를 포함시키지않는다.
http://restapi.example.com/members/soccer/345/photo.jpg (X)
URI에 행위는 포함시키지않는다.
POST http://api.test.com/users/1/delete-post/1 (X)
_은 URI에 사용하지않는다.
-를 사용하여 URI를 쉽게 읽고 해석할 수 있도록 한다.
POST http://api.test.com/users/1/board_post/1 (X)'이론' 카테고리의 다른 글
| HTTP 응답상태코드 (0) | 2023.10.23 |
|---|---|
| REST API(아키텍처)의 특징 (0) | 2023.10.23 |
| REST의 구성: 자원, 행위, 표현 (0) | 2023.10.23 |
| REST와 REST API, 그리고 RESTful (0) | 2023.10.23 |
| API란? (0) | 2023.10.23 |
