Sunday_August_9
.
.
.
앞서 짧고 간략하게 RESTful에 대해 작성을 했지만,
멘토님의 세션을 듣고 너무 재밌고 쉽게 와닿아서 다시 써보려고 한다.
(사실 그 전에는 잘 몰랐었다 ㅠ)

💰 메소드 & 자원

url는 메소드(동사)와 자원(명사)로 이루어진다.

메소드(동사)들
보고 싶으면 GET
추가하고 싶으면 POST
삭제하고 싶으면 DELETE
수정하고 싶으면 PUT/PATCH (둘의 차이는 아래에서)

url은 엔드포인트를 향해 가는 주소이다.
프론트에서 만드는 웹페이지 기준이 아니라 리소스기준이 되어야한다.
상품을 건드리는 거면 url이 product가 되어야 하고
사용자를 건드리면 url은 user,
리뷰를 건드리면 url은 review가 되어야 한다.

예를 들어 같은 자원을 건드리는 엔드포인트라면

상품을 나열한다던가, 조건을 주어서 필터링을 한다던가, 특정 기준으로 정렬을 한다던가 등.

엔드포인트는 하나이고 메소드가 바뀌는 것이다.

그냥 상품을 보는 url은
get product이고

상품을 추가하는 url은
post product이다.

만약 상품을 수정하는 url은
put/patch product 이다.
물론 어떤 상품을 수정할지는 알려주어야 한다.

put/patch product/3 (만약 3번 상품 이었다면)
이렇게 말이다.

그리고 또 6번의 상품을 삭제하고 싶다면
delete product/6
이렇게 써주면 된다.

이렇게 같은 product라는 자원을 건드렸고 엔드포인트는 하나였다.

그리고 우리가 만약 어떠한 상품을 보려고 한다면 url은
get http://127.0.0.1:8000/product/1
이런식을 볼텐데, 하드코딩으로 항상 1, 2, 3... 이렇게 만들어 줄 수는 없다.

장고의 urls.py에서 경로로 (프로젝트 urls.py에 product를 주었다는 가정하에)
path('/1', 생략),
path('/2', 생략) 이렇게 나가는 것이 아니라
path('/<int:product_id>', 생략) 이렇게 나가는 것이다.

😡 잘못된 예시

1️⃣

get http://127.0.0.1:8000/product/main_page_product

메인 페이지에는 여러가지의 정보가 올 수 있다.
예를 들어 user정보와 product의 정보가 메인 페이지에서 나온다면,
user와 product라는 리소스를 가진 엔드포인트 2개를 동시에 호출해서 보여주는 것이다.

예를 들어
get http://127.0.0.1:8000/user
get http://127.0.0.1:8000/product

이렇게 2개의 엔드포인트를 동시에 호출한다고 생각하면 된다.

2️⃣

get http://127.0.0.1:8000/store/find_store
딱 보니까 어떠한 store를 찾고싶은듯 하다.

하지만 위에서 말했듯 get이라는 메소드를 사용했고, store라는 자원(리소스)에 접근을 했다. 따라서 find_store라고 쓰면 안된다.

서울에 있는 매장을 검색하고 싶다면 다음과 같이 하면 된다.
일단 조건을 주어야 한다.

get http://127.0.0.1:8000/store?district='seoul'
get http://127.0.0.1:8000/store?city='seoul'

등으로 주면 된다.

3️⃣

post http://127.0.0.1:8000/product/add_first_item_information?name='jacket'&category='dress'

이제 문제점이 눈에 보일 것이다.

딱 봐도 첫 번째 아이템에 카테고리는 드레스, 이름은 자켓으로 상품을 추가한다는것 같다.

post http://127.0.0.1:8000/product
이렇게 한 후,
body에다가 내부에 json의 형태로

{
	"name":"jacket",
    "category":"dress"
}

이렇게 주면 된다.

4️⃣

post http://127.0.0.1:8000/store/search_store?name='강남'

이것 또한 강남에 있는 매장을 찾고 싶었던 듯 하다.

일단 매장을 찾아서 보는 것이기 때문에 메소드는 post가 아닌 get이 되어야 한다. 그리고 굳이 필요없는 search_store라는 부분, 우리는 이미 앞에서 store라는 리소스(자원)을 언급했기 때문에 저렇게 까지 알려줄 필요는 없다.

따라서 올바른 rest규칙을 사용하면 다음 같이 나타낼 수 있다.

get http://127.0.0.1:8000/store?name=강남'

🤔 Put과 Patch의 차이

짧고 굵게 끝내겠다.

만약 키 값이 3개라고 가정을 하면

Put은 3개의 키 값을 다 써주어야 하고,
Patch는 1개 이상이면 된다.

즉,
Put은 전체 수정이고,
Patch는 일부 수정이다.