🔥TIL#9. RESTful API

Today I learned

1. Restful API 란?
2. query parameter
3. path parameter
4. 주의 사항

1. Restful API

API에서 전송하는 resource를 URI로 표현하고 해당 자원에 행하고자 하는 의도를 HTTP 메소드로 정의.

2. query parameter

GET method 에 해당하는 url 에 대해 filtering, paging 한 결과를 받고 싶은 경우 사용. 주로 무한 scroll 화면에서 자주 사용.

GET http://localhost:8000/places?id=1&region=서울		# filtering
GET http://localhost:8000/places?offset=0&limit=100		# paging

django view에선 아래와 같이 처리한다.

class PlacesView():
	def get(self, request):
    		id    	= request.GET.get(id, None)
        	region	= request.GET.get(region, None)
            	offset 	= request.GET.get(offset, None)
                limit	= request.GET.get(limit, None)

값이 있는게 확실하다면 request.GET['id'] 방식도 사용 가능하다.

3. path parameter

하나의 자원에 대한 GET, PATCH(update), DELETE method에 해당하는 url의 경우 사용하는 방식

http://localhost:8000/place/places/1
http://localhost:8000/place/places/원룸

django view에선 아래와 같이 처리한다.

from django.urls import path
from . import views

urlpatterns = [
    path('/places/<int:place_id>', views.GetDetailPlaceView),    
    path('/places/<str:category>', views.GetPlaceWithCategoryView),    
]

이를 View에서 처리하는 코드는 아래와 같다.

class GetDetailPlaceView():
	def get(self, request, place_id):
    		place = Place.objects.filter(id=place_id)
            	return JsonResponse({"place":place.values()}, status=200)

class GetPlaceWithCategoryView():
	def get(self, request, category):    		    		
            categories = Category.objects.prefetch_related('place_set').all()

            places = [category.place_set.values() for category in categories]
            return JsonResponse({"place":places}, status=200)

url parameter 방식을 사용할때는 get, post 메소드의 parameter에 urls에서 선언한 변수명을 추가하면 된다.

4. 주의 사항

1. url은 resource 기준으로 가야한다.
2. Method가 있으므로 동사를 쓰지 않는다.(나쁜 예. /get_places)