REST API

JEON.HYEONG.JUN·2022년 5월 7일
0

REST라는 뜻은 웹에 존재하는 모든 자원(resource, ex. 이미지, 동영상, 데이터)에 고유한 URI를 부여하여 자원에 대한 주소를 지정하는 방법론, 또는 규칙이다.
그리고 RESTful API는 REST 특징을 지키면서 API를 제공한다는 의미이다. 쉽게 설명하자면 "프론트엔드에서 백엔드 API를 호출할 url을 어떻게 만들것인가?"에 대한 것이다.

그러나 RESTful하다라는 것은 REST API의 설계 규칙을 올바르게 지킨 시스템을 RESTful하다 말할 수 있으며,

모든 CRUD 기능을 POST로 처리 하는 API 혹은 URI 규칙을 올바르게 지키지 않은 API는 REST API의 설계 규칙을 올바르게 지키지 못한 시스템은 REST API를 사용하였지만 RESTful 하지 못한 시스템이라고 할 수 있다.

REST에서의 CRUD Operation 동작 예시는 위와 같다.

📌 올바른 RESTful API 설계 가이드

https://library.gabia.com/contents/8339/ 이 링크에 있는 설계 가이드를 참고했고, 회사마다 다를 수 있다.

  1. 마지막에 / 을 포함하지 않는다.

  1. _(underbar) 대신 -(dash)를 사용한다.

-(dash)의 사용도 최소한으로 설계한다. 정확한 의미나 표현을 위해 단어의 결합이 불가피한 경우 반드시 -(dash) 사용한다.

그리고 'post-commnets' 이런 식으로 대문자가 아닌 소문자를 사용한다.

  1. 행위(method)는 URL에 포함하지 않는다.

  1. 컨트롤 자원을 의미하는 URL 예외적으로 동사를 허용한다.


함수처럼, 컨트롤 리소스를 나타내는 URL은 동작을 포함하는 이름을 짓는다.

profile
💻😀👍🎁👏😁

0개의 댓글