0. Introduction

해당 강의는 러닝스푼즈 - 나노디그리 Python & Django backed course의 김형종 강사님의 django 강의를 학습한 내용입니다.
그리고, Django REST framework를 함께 참고하여 학습했습니다.
이번에는 django의 외부 라이브러리인 DRF(Django Rest-Framework)에 대해 학습한 걸 정리했습니다.
- DRF와 DRF의 핵심인 직렬화가 무엇인지
- 어떤 흐름으로 설계를 진행하는지
- ModelViewSet, @api_view, ViewSet 각각으로 view를 만드는 방법
- Serializer 설계
DRF 강의 내용을 정리한 이유는 DRF는 api 설계에 주로 사용하기 때문에, 정답이라는 게 없어서 많이 사용하는 내용을 정리할 필요를 느꼈습니다.

1. DRF의 이점

모든 것을 DRF로 구현하는 게 아닌, DRF 기능 중 선별적으로 필요한 것만 골라서 사용한다.

최종적으로는 API를 만드는 것이지만, 구체적으로는 다음과 같다. 하지만, 아래 언급한 기능 외에도 매우 많은 기능들이 있으므로, 아래 기능들을 기본으로 살을 붙여나가자.

첫 번째, Serializer
두 번째, Response
세 번째, APIView
네 번째, Policy

DRF - Serializer

json library는 json으로 직렬화가 가능하지만, Django object까지는 처리하지 못한다.

DRF - Response

DRF의 모든 기능을 사용하여 API를 만드는 게 아니라, DRF의 기능을 선별적으로 사용한다.

1
2
3
4
5
## django에서는 다음 모듈을 사용
from django.http import JsonResponse

## DRF에서는 다음 모듈을 사용
from rest_framework.response import Response

DRF - APIView

DRF로 API를 만들 때 사용하는 방법들 3가지: APIView, @api_view, ModelViewSet

APIView

1
2
3
4
5
# CBV
# TemplateView와 유사
class LessonAPIView(APIView):
	def get(self, request):
		return

@api_view([“GET”]])

1
2
3
4
# FBV
@api_view(["GET"])
def get_lesson(request):
	return 

ModelViewSet 상속

1
2
3
4
5
# DRF에서 제공하는 ModelViewSet
# FormView와 유사
class LessonViewSet(ModelViewSet):
	queryset = Lesson.objects.all() 
	serializer_class = LessonSerializer

DRF - Policy

DRF에서 제공하는 유용한 기능 ‘Policy’

authentication_classes & permission_classes
- api 서버에 접근하여 가져올 때, 권한 부여
pagination_class
- pagination 만들기
throttle_scope
- api를 다룰 때 횟수 제한이 있다.
- 이 횟수제한을 다루는 기능

2. DRF에 사용할 models.py

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
from django.db import models
from django.contrib.auth.models import User


class Company(models.Model):
    SCALES = [(0, "10명미만"), (1, "50명미만"), (2, "100명미만"), (3, "300명미만"), (4, "500명미만")]

    name = models.CharField(verbose_name="회사명", max_length=30)
    scale = models.IntegerField(verbose_name="규모", choices=SCALES, null=True)

    def __str__(self):
        return f"{self.name} ({self.get_scale_display()})"

    class Meta:
        verbose_name = "회사"
        verbose_name_plural = "회사 목록"


class Employee(models.Model):
    company = models.ForeignKey(Company, on_delete=models.CASCADE, verbose_name="소속(회사)")
    user = models.OneToOneField(User, on_delete=models.CASCADE, verbose_name="유저")

    name = models.CharField(verbose_name="이름", max_length=10)
    phone = models.CharField(verbose_name="연락처", max_length=11)
    team = models.CharField(verbose_name="소속(팀)", max_length=30)

    is_agreed = models.BooleanField(verbose_name="이용약관 동의", default=False)

    def __str__(self):
        return f"{self.name} ({self.company})"

    class Meta:
        verbose_name = "임직원"
        verbose_name_plural = "임직원 목록"

3. View 설계: APIView

APIView를 사용하여 View를 설계해보고, django에서 제공하는 JsonResponse와 DRF에서 제공하는 Response를 비교해본다.

3.1: from django.http import JsonResponse
3.2: from rest_framework.response import Response
3.3: 직렬화 추가

🔆 url에 매핑하는 방식은 기존 CBV 방식과 동일하다.

3.1 JsonResponse

TypeError: Object of type Queryset is not JSON serializable

위 모델들이 바로 직렬화가 안되면 이 모델들을 dictionary 형태로 바꾸고 나서 직렬화를 진행하면 가능하다. 이를 아래 view 코드를 통해서 확인해보자.
아래 result의 결과는 Json 직렬화를 할 수 없다는 Error가 발생한다.
- TypeError: Object of type QuerySet is not JSON serializable
왜냐하면 queryset은 jsonresponse로 던질 수 있는 적합한 타입이 아니다.
- queryset은 파이썬이 아닌 장고에서 만든 것이다.
그래서 파이썬에서 만들 수 있는 자료형으로 형변환 후, 이를 JsonResponse에 전달한다.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# user/views.py
from rest_framework.views import APIView
from django.http import JsonResponse 

class EmployeeListAPIView(APIView):
	def get(self, request): 
		employee_qs = Employee.objects.all() 

		result = {"employee_list": employee_qs}

		return JsonResponse(result)

queryset을 다른 data type으로 변환 후, 직렬화하기

그래서 위 내용을 다음과 같이 python의 다른 형태로 형변환하면 화면 상에서 볼 수 있다.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# user/views.py
from rest_framework.views import APIView
from django.http import JsonResponse 

class EmployeeListAPIView(APIView):
	def get(self, request): 
		employee_qs = Employee.objects.all() 
        
		# 아래처럼 입력하면 employee_list 라는 key 값에 value가 list형태인 것으로 직렬화되어 출력된다.
		result = {"employee_list": list(employee_qs.values_list('name', flat=True))}
		
		return JsonResponse(result)

3.2 Response

아래 코드를 기반으로 화면을 보면 위에 JsonResponse와 달리 Http message 형태로 볼 수 있다.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from rest_framework.views import APIView
from rest_framework.response import Response

class EmployeeListAPIView(APIView):
	def get(self, request): 
		employee_qs = Employee.objects.all() 
        
		# 아래처럼 입력하면 employee_list 라는 key 값에 value가 list형태인 것으로 직렬화되어 출력된다.
		result = {"employee_list": list(employee_qs.values_list('name', flat=True))}
		
		return Response(result)

3.3 Serializers 추가하기

먼저 ./serializers.py에서 EmployeeSerializer 를 만든다.

1
2
3
4
5
6
7
8
from rest_framework.serializers import ModelSerializer
from user.models import Employee


class EmployeeSerializer(ModelSerializer):
    class Meta: 
        model = Employee
        fields = "__all__"

그리고 이를 APIView에 추가한다.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from rest_framework.views import APIView
from rest_framework.response import Response

class EmployeeListAPIView(APIView):
	def get(self, request): 
		employee_qs = Employee.objects.all() 
        
		serializer = EmployeeSerializer(employee_qs, many=True)
		
		return Response(serializer)

결과는 2.2 Response 방식과 동일하다.

하지만, 코드는 보다 간결해진 걸 알 수 있다.

만약 모든 필드가 아닌 원하는 필드면 입력하여 뽑아낼 수 있다.

fields = '__all__'이 아닌 fields = ['name']을 입력하면 ’name’에 관련된 것만 가져온다.

4. View 설계: @api_view([’’])

@api_view([''])를 사용하여 위에 CBV로 만든 것과 내용을 동일하게 하면서 FBV로 만들어보겠다.

데코레이터의 인자로는 리스트 데이터 타입으로 입력해야 한다.

1
2
3
4
5
6
7
8
9
from rest_framework.serializers import ModelSerializer
from rest_framework.decorators import api_view
from user.models import Employee

@api_view(['GET'])
def employee_list(request):
	employee_qs = Employee.objects.all() 
	serializer = EmployeeSerializer(employee_qs, many=True)
	return Response(serializer.data)

🔆 url에 매핑하는 방식은 기존 FBV 방식과 동일하다.

5. View 설계: ViewSet

CBV 방식으로서, naming은 class <Model name>ViewSet(ModelViewSet):로 한다.

ModelViewSet을 받아서 ViewSet을 만든다.
이 때 2가지 옵션을 단다.
- queryset, serializer_class 를 만든다.
queryset 은 <모델명>.objects.all() 을 만들어 할당한다.
serializer_class에 해당하는 건 <모델명>Serailizer로 작성한다.

1
2
3
4
5
6
7
8
# course/views.py 

from rest_framework.viewsets import ModelViewSet
from .serialization import EmployeeSerializer

class EmployeeViewSet(ModelViewSet):
	queryset = Course.objects.all() 
	serializer_class = EmployeeSerializer 

url에 mapping 하기

일반적인 cbv 방식과 달리 다음과 같이 DefaultRouter를 가져온다.

Router의 역할

router는 nginx처럼 여러 군데로 보내는 역할을 수행한다.
router를 만들어서 여기에 .register를 사용하여 등록했다.
router가 ModelViewSet을 사용하여 url를 여러개 만들어주는 역할을 한다.
- url 뒤에 pk 입력하는 url 설계는 하지 않았음에도 불구하고, 뒤에 pk를 입력하면 해당되는 데이터가 뜬다.
router.register의 수는 ModelViewSet으로 만들고 싶은 Model의 갯수만큼 입력한다.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# users/views.py
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import EmployeeViewSet

router = DefaultRouter() 
router.register('employee', EmployeeViewSet)

urlpatterns = [
	path("", include(router.urls))
]

6. 자주 사용되는 view 설계

ViewSet보다 APIView를 훨씬 많이 사용한다.

FormView를 잘 사용하지 않는 이유
- 요구사항이 바껴서 적용하기 힘들 때, form에 post를 전달하는 것 대신에 Ajax로 API를 체크한다.
ModelViewSet을 잘 사용하지 않는 이유: 최적화의 어려움
- ModelViewSet으로는 API를 자세하게 다룰 수 없어서, APIView를 주로 사용한다.
- 왜냐하면 ModelViewSet에는 CRUD가 다 존재하기 때문이다.

Reference

러닝스푼즈 - 나노디그리 Python & Django backed course

0. Introduction#

1. DRF의 이점#

DRF - Serializer#

DRF - Response#

DRF - APIView#

APIView#

@api_view([“GET”]])#

ModelViewSet 상속#

DRF - Policy#

2. DRF에 사용할 models.py#

3. View 설계: APIView#

3.1 JsonResponse#

TypeError: Object of type Queryset is not JSON serializable#

queryset을 다른 data type으로 변환 후, 직렬화하기#

3.2 Response#

3.3 Serializers 추가하기#

4. View 설계: @api_view([’’])#

5. View 설계: ViewSet#

url에 mapping 하기#

Router의 역할#

6. 자주 사용되는 view 설계#

Reference#