Session | Restful API

1. Restful API란?

• 백엔드에서 엔드포인트를 구현하는 방식 중 하나로 API에서 전송하는 자원(resource)을 URI로 표현하고, 해당 자원에 행하고자 하는 의도를 HTTP메소드로 정의한다.

• 각 엔드포인트는 리소스를 표현하는 고유의 URI 주소를 가지고 있으며, POST, GET, PUT, PATCH와 같은 HTTP 메소드를 처리할 수 있게 된다.

Ref. URI

2. Path parameters

1) GET

상세페이지를 보고자 할 때 http://10.54.4.1:8000/products로 GET 요청을 하면 모든 제품 정보가 끌려온다. 따라서 하위 경로에 1, reviews 등으로 표시해서 원하는 정보를 가져오는 것을 path parameters라고 함.

2) POST, PATCH

POST

request 메시지를 body에 담아 Frontend에게 다시 response

PATCH (데이터 업데이트)

1번 상품의 가격을 업데이트 할 때 path parameter(1)에 그 내용을 담아 response함. path parameter에는 string이나 int가 올 수 있지만 id값을 넣는게 가장 정확함.

DELETE

컨텐츠가 정상적으로 삭제됐을 때 status 204로 응답(restful API로 지워졌을 때)

3. Query String

? : query string (또는 query parameter)

price가 3천원인 항목 모두 찾기

GET /products?ordering=-id
최신 순으로 필터링

GET /products?offset=0&=limit=100

GET /users?search

4. 언제 어떤 방법을 사용해야 할까?

Path Parameter vs. Query String

5. 좋은 예와 나쁜 예

나쁜예) GET과 find는 중복, filter대신 ?name= 등을 이용해서 구현 가능

6. 상태 코드(status code)