0. Introduction

  • 해당 강의는 러닝스푼즈 - 나노디그리 Python & Django backed course의 김형종 강사님의 django 강의를 학습한 내용입니다.

  • 그리고, Django REST framework를 함께 참고하여 학습했습니다.

  • 이번에는 django의 외부 라이브러리인 DRF(Django Rest-Framework)에 대해 학습한 걸 정리했습니다.

    • DRF와 DRF의 핵심인 직렬화가 무엇인지
    • Serializer 설계

  • DRF 강의 내용을 정리한 이유는 DRF는 api 설계에 주로 사용하기 때문에, 정답이라는 게 없어서 많이 사용하는 내용을 정리할 필요를 느꼈습니다.

 

1. DRF(Django RestFramework)란?

REST 규격에 맞는 api 설계를 간편하게 해주는 django library

REST API

  • REST란?

    • resource를 중심으로 디자인: 행위 부분은 HTTP method로 표현
    • 특정 리소스를 고유하게 식별하는 식별자
      • ex) id
    • 요청 및 응답 포맷으로는 JSON을 많이 사용
    • 균일한 인터페이스를 적용

  • 이러한 REST 설계 원칙을 준수한 API를 준수한 REST API라 한다.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

## 나쁜 예시
/get/lesson/
/create/lesson/
/delete/lesson/1

/groups/8SUE9E/courses/finance/lessons/

## 좋은 예시
/lessons/  와 GET method 사용
/lessons/  와 POST method 사용
/lessons/1/ 와 DELETE method 사용

# 긴 api가 아니라, courses/로 이동한다. 
/groups/8SUE9E/courses/ 
courses/finance/lessons/

CRUD: HTTP method POST, GET, UPDATE & PATCH, DELETE

위 HTTP 메서드에 해당되는 CRUD 수행을 간편하게 해주는 외부 라이브러리다.

장고의 기본 모듈이 아닌 외부 라이브러리지만, 잘 만들어져서 다들 다양하게 사용한다.

 

DRF installation

  • 설치 명령어
1

pip install djangorestframework
  • 그리고, settings/base.py 의 INSTALLED_APPS에 추가한다.
1
2
3
4

INSTALLED_APPS = [
	...
	"rest_framework",
]

 

2. 직렬화와 역직렬화

- 직렬화(Serialization): instance -> dict(json) -> bystring
- 역직렬화(Deserialization): bystring -> dict(json) -> instance

직렬화(Serialization)

데이터를 네트워크를 통해서 전달한다는 의미는 API로 전달하는 것 이라 생각하면 된다.

그런데 이 데이터를 웹 애플케이션은 https, http 프로토콜을 사용하여 전달하며, 이는 HTTP message의 body 부분에 담아서 보낸다는 걸 의미한다.

이때 담기 위해서는 json 형태여야하고, 이를 네트워크 기계를 통해서 전달해야하므로 최종적으로 bystring 형태로 보내야 한다.

이 네트워크를 통해 전달하기 위해서 수행되는 instance -> json: dictionary -> bystring 과정을 직렬화라고 한다.

역직렬화(Deserialization)

api를 통해서 전달받은 데이터를 원하는 객체 타입으로 전환하는 과정을 말한다.

bystring -> json:dictionary -> instance

serialization.py

직렬화를 수행하기 위해서는 views.py, urls.py, models.py, forms.py 처럼 serialization.py 가 존재해야 한다.

  • settings.py 가 분기되어 있을 때라면 다음과 같이 실행한다.

    1

    python mange.py serialization --settings=config.settings.develop

코드를 통해 이해해보기

그러면 코드를 통해 직렬화를 간단히 이해해보자.

  • Serializer 작명법

    • 아래 코드에서 LessonSerializer는 <model 명>Serializer로 작성하는 작성법에 맞춰서 작성한 것이다.

  • 아래 내용은 DRF 튜토리얼 내용을 학습하면서 정리한 내용이다.

직렬화

  • instance 생성하기
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework.renderers import JSONRenderer
from rest_framework.parsers import JSONParser

## instance 생성 
>>> snippet = Snippet(code='foo = "bar"\n')
>>> snippet.save()

>>> snippet = Snippet(code='print("hello, world")\n')
>>> snippet.save()
  • instance를 dictionary json으로 전환: Serializer
1
2
3
4
5
6
7
8
9

>>> serializer = SnippetSerializer(snippet)
>>> print(type(serializer))
<class '<app 이름>.serializer.SnippetSerializer'>

>>> serializer.data
{'id': 2, 'title': '', 'code': 'print("hello, world")\n', 'linenos': False, 'language': 'python', 'style': 'friendly'}

>>> print(type(serializer.data))
<class 'rest_framework.utils.serializer_helpers.ReturnDict'>
  • dictionary json을 bystring으로 전환: JSONRender
    • 네크워크를 통해서 전달될 때는 JSON 형태로 전달되므로 JSONRenderer를 사용한다.
1
2
3
4
5
6
7

>>> content = JSONRenderer().render(serializer.data)

>>> print(type(content))
<class 'bytes'>

>>> print(content)
b'{"id":null,"title":"","code":"foo=\\"bar\\"\\n","linenos":false,"language":"python","style":"friendly"}'

 

역직렬화

  • bystring을 dictionary json으로 전환: JSONParser
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

>>> import io
>>> stream = io.BytesIO(content)
>>> stream
<_io.BytesIO object at 0x7fcc89a27f40>

>>> data = JSONParser().parse(stream)
>>> data
{'id': None, 'title': '', 'code': 'foo="bar"\n', 'linenos': False, 'language': 'python', 'style': 'friendly'}

>>> print(type(data))
<class 'dict'>
  • dictionary json을 다시 instance로 전환: Serializer
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

>>> serializer = SnippetSerializer(data=data)
>>> print(type(serializer))
<class 'quickstart.serializer.SnippetSerializer'>

>>> serializer.is_valid()
True

>>> serializer.validated_data
OrderedDict([('title', ''), ('code', 'foo="bar"'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])

>>> print(type(serializer.validated_data))
<class 'collections.OrderedDict'>
  • formView에서 항상 valid 체크를 했었다. 이것이 통과되면 값을 뽑아낸다.
  • 딕셔너리로 받은 것을 유효성 체크 후, 모델로 받은 것이다.

instance가 아닌 querysets을 직렬화하기

쿼리셋을 직렬화할 때는 옵션으로 ‘many=True’를 사용한다.

1
2

>>> serializer = SnippetSerializer(Snippet.objects.all(), many=True)
>>> serializer.data

 

3. 직렬화 코드 작성하기

  • Serializer는 FormView와 유사하다.

  • Serializer의 class name은 <Model명>Serializer 로 작성한다.

  • fields의 역할은 가져오는 정보 종류를 의미한다.

    • "__all__" 이면 모든 정보를 다 가져온다.
    • 하지만 "code" 를 하면 code만 가져온다.

  • drf의 view인 APIView 라는 걸 이용해서 하나 하나 api를 구현할 수 있지만, drf는 설정한대로 하면 금방한다.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

# course/serialization.py

from rest_framework import serializers 
from course.models import Course, Group, Registration

class CourseSerializer(serializers.ModelSerializer):
	class Meta:
		model = Course
		fields = "__all__"
		# fields = ["code"] 
		# 만약 이렇게 하면 code만 가져온다. 
			
class GroupSerializer(serializers.ModelSerializer):
	class Meta:
		model = Group
		fields = "__all__"

class RegistrationSerializer(serializers.ModelSerializer):
	class Meta:
		model = Registration
		fields = "__all__"

 

 

Reference