jinsusong / CS-Study

CS
3 stars 5 forks source link

RESTful이란 ?? #3

Open jinsusong opened 1 year ago

SW-H commented 1 year ago

Restful API

REST를 기반으로 만들어진 API 이면서 REST API의 설계 규칙을 올바르게 지킨 시스템

REST(Representational State Transfer) : 자원을 이름으로 구분하여 해당 자원의 상태를 주고받는 모든 것

REST의 특징

  1. Server-Client(서버-클라이언트 구조)
  2. Stateless(무상태)
  3. Cacheable(캐시 처리 가능)
  4. Layered System(계층화)
  5. Uniform Interface(인터페이스 일관성)

REST API 설계 예시

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

method는 동사의 의미를 갖고 DB 동작이 기준이다

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

👎🏻  http://khj93.com/test/   👍🏻  http://khj93.com/test

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

👎🏻 http://khj93.com/test_blog 👍🏻 http://khj93.com/test-blog

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

👎🏻 http://khj93.com/photo.jpg   👍🏻  http://khj93.com/photo

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

👎🏻 http://khj93.com/delete-post/1   👍🏻  http://khj93.com/post/1

  1. 리소스는 명사, 주로 복수형, 슬래시 4칸을 넘어가지 않도록 설계한다.
anuu0916 commented 1 year ago

출처 : https://dev-coco.tistory.com/97

SW-H commented 1 year ago

Restful API : 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기

developer-sora commented 1 year ago

그런 REST API로 괜찮은가 https://www.youtube.com/watch?v=RP_f5dMoHFc