RESTful API

dnjstd·2021년 12월 5일
0

REST

REpresentation State Tramsger의 약자

웹이 존재하는 모든 자원에 고유한 URI를 부여해 주소를 지정하는 방법론, 규칙을 말한다.
RESTful API는 REST 특징을 지키면서 API를 제공한다는 의미이다.

REST 규칙에 어긋나는 url 예시

[GET] http://127.0.0.1:8000/product/main_page_product
  • url 은 page 기준이 아닌 resource 기준으로 작성
  • 메인 페이지에 표출되어야할 정보가 무엇인지 판별하여 url을 정한다.
  • 한 번에 여러 종류의 정보를 표출해야 한다면, 프론트엔드 개발자와 협의하여 REST에 맞춰 두가지 이상의 endpoint를 동시에 호출한다.
[GET] http://127.0.0.1:8000/store/find_store
  • 동사(find)를 사용하지 않는다.

Query parameters (GET parameters)

웹 페이지의 url 주소를 보면 종종 ?가 포함되어 있는 것을 볼 때가 있다. 물음표는 특정한 기능을 수행하고 있는데, 물음표 뒤에는 key=value 형식의 문자열이 따라온다. 이것을 Query parameter라고 부른다.

Path parameters

API URI로 통신을 하는 것을 'path parameter를 사용하여 통신한다'고 한다.

1.RESTful API - GET

2.RESTful API - POST, PATCH

3.RESTful API - DELETE

profile
Frontend Engineer 🌱

0개의 댓글