Serialization | REST Framework Tutorial

공식문서를 직접 번역하고 공부한 글입니다!

> 가상환경 세팅

별개의 프로젝트 구성을 위해 가상환경을 설치하자.

python3 -m venv env
source env/bin/activate

패키지 설치

pip install django
pip install djangorestframework
pip install pygments  # We'll be using this for the code highlighting

> 시작하기

가상환경 설치가 완료 되었다면 새로운 프로젝트를 생성하자.

cd ~
django-admin startproject tutorial
cd tutorial

완료되었다면 간단한 Web API을 생성하기위해 사용할 앱을 생성하자.

python manage.py startapp snippets

새로 생성한 snippets앱과 rest_framework를 tutorial/settings.py안에 INSTALLED_APPS에 추가하자.

INSTALLED_APPS = [
    ...
    'rest_framework',
    'snippets.apps.SnippetsConfig',
]

> 작업할 모델 생성

코드 조각들을 저장할 Snippet 모델을 snippets/models.py에 생성하자.

from django.db import models
from pygments.lexers import get_all_lexers
from pygments.styles import get_all_styles

LEXERS           = [item for item in get_all_lexers() if item[1]]
LANGUAGE_CHOICES = sorted([(item[1][0], item[0]) for item in LEXERS])
STYLE_CHOICES    = sorted([(item, item) for item in get_all_styles()])

class Snippet(models.Model):
    created  = models.DateTimeField(auto_now_add=True)
    title    = models.CharField(max_length=100, blank=True, default='')
    code     = models.TextField()
    linenos  = models.BooleanField(default=False)
    language = models.CharField(choices=LANGUAGE_CHOICES, default='python', max_length=100)
    style    = models.CharField(choices=STYLE_CHOICES, default='friendly', max_length=100)

    class Meta:
        ordering = ['created']

snippet 모델을 생성했으니, migration을 함으로써 데이터베이스를 동기화 해주어야 한다.

python manage.py makemigrations snippets
python manage.py migrate

> Serializer 클래스 생성

Web API를 시작하기에 제일 먼저 필요한 것은 json과 같이 대표적인 유형으로 snippet 인스턴트들을 직렬화와 역직렬화 할 수 있는 방법을 제공하는 것이다.
snippets 디렉토리에 serializers.py 일을 생성해주고 아래와 같이 작성해주자.

from rest_framework import serializers
from snippets.models import Snippet, LANGUAGE_CHOICES, STYLE_CHOICES

class SnippetSerializer(serializers.Serializer):
    id       = serializers.IntegerField(read_only=True)
    title    = serializers.CharField(required=False, allow_blank=True, max_length=100)
    code     = serializers.CharField(style={'base_template': 'textarea.html'})
    linenos  = serializers.BooleanField(required=False)
    language = serializers.ChoiceField(choices=LANGUAGE_CHOICES, default='python')
    style    = serializers.ChoiceField(choices=STYLE_CHOICES, default='friendly')

    def create(self, validated_data):
        """
        Create and return a new `Snippet` instance, given the validated data.
        """
        return Snippet.objects.create(**validated_data)

    def update(self, instance, validated_data):
        """
        Update and return an existing `Snippet` instance, given the validated data.
        """
        instance.title    = validated_data.get('title', instance.title)
        instance.code     = validated_data.get('code', instance.code)
        instance.linenos  = validated_data.get('linenos', instance.linenos)
        instance.language = validated_data.get('language', instance.language)
        instance.style    = validated_data.get('style', instance.style)
        instance.save()
        return instance

serializer 클래스의 첫 부분은 직렬화 혹은 역렬화 될 필드들을 정의하는 것이다.
create()과 update() 메소드를 사용함으로써 인스턴트가 serializer.save()을 호출할 때 얼마나 완전히 독립적으로 생성되고 수정될 수 있는 있는지 정의한다.

Serializer 클래스는 Django의 Form 클래스와 매우 비슷하며, required, max_length 그리고 default 같은 필드들의 관한 validation flags를 포함한다.

또한, 필드 플래그들은 HTML으로 렌더링 할 때와 같은 특정한 상황에 serializer가 어떻게 보여져야 하는지 제어할 수 있다.  Serializer 클래스에서 사용하는 {'base_template': 'textarea.html'} 플래그는 장고 폼 클래스에서widget=widgets.Textarea를 사용하는것과 동일하다. 위 방법은 나중에 튜토리얼에서 배울 것처럼 browable API가 보여지는 방법을 제어하기에 특히나 유용하다.

> Serializers 사용하기

먼저 serializer 클래스와 익숙해지기 위해 Django shell로 연습을 해보자.

python manage.py shell

몇 가지 모듈들을 import하고 snippet들을 생성해주자.

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

snippet = Snippet(code='foo = "bar"\n')
snippet.save()

snippet = Snippet(code='print("hello, world")\n')
snippet.save()

이제 몇 개의 snippet 인스턴스들이 생겼고, serializing 해볼 수 있다.

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

이 시점까지의 작업이 모델 인스턴스들을 순수 파이썬 데이터타입으로 바꿔준 것이다.
직렬화 과정을 마무리하기 위해선 지금의 데이터를 json으로 렌더링 해주어야한다.

content = JSONRenderer().render(serializer.data)
content
# b'{"id": 2, "title": "", "code": "print(\\"hello, world\\")\\n", "linenos": false, "language": "python", "style": "friendly"}'

역직렬화를 하는 방법도 비슷하다.
먼저 stream(흐름, 중간과정 같은 역할)을 순수 파이썬 데이터타입으로 파싱해준다.

import io

stream = io.BytesIO(content)
data = JSONParser().parse(stream)

그리고나서 순수 파이썬 데이터타입을 완전하게 객체 인스턴스로 바꾸어준다.

serializer = SnippetSerializer(data=data)
serializer.is_valid()
# True
serializer.validated_data
# OrderedDict([('title', ''), ('code', 'print("hello, world")\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])
serializer.save()
# <Snippet: Snippet object>

이처럼 API는 장고의 폼을 사용하는 것과 비슷하다.
이렇게 둘의 비슷한 점들이 view를 작성하기 시작하면 더 명백해지게된다.

또한 모델 인스턴스를 직렬화하는 것을 넘어 쿼리셋을 직렬화 할 수도 있다.
간단히 many=True 플래그를 serializer 인자로 지정해주면 된다.

serializer = SnippetSerializer(Snippet.objects.all(), many=True)
serializer.data
# [OrderedDict([('id', 1), ('title', ''), ('code', 'foo = "bar"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 2), ('title', ''), ('code', 'print("hello, world")\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 3), ('title', ''), ('code', 'print("hello, world")'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])]

> ModelSerializers 사용하기

SnippetSerializer 클래스는 Snippet모델안에 이미 담겨져 있는 많은 정보들을 되풀이한다.
그러므로 사용자가 코드를 조금 더 간결하게 작성할 수 있다면 더 좋을 것이다.

장고가 Form 클래스와 ModelForm 클래스를 제공하는 것과 같이, REST Framework도 Serializer 클래스와 ModelSerializer 클래스를 제공한다.

방금 만들었던 ModelSerializer 클래스를 ModelSerializer 클래스로 리팩토링 해보자.

snippets/serializers.py를 다시 열어서, SnippetSerializer 클래스를 아래와 같이 변경한다.

class SnippetSerializer(serializers.ModelSerializer):
    class Meta:
        model = Snippet
        fields = ['id', 'title', 'code', 'linenos', 'language', 'style']

모델 serializer가 가진 훌륭한 속성 중 하나는 사용자가 인스턴스 표현들을 출력함으로써 serializer 인스턴스 안에 있는 모든 필드들을 확인할 수 있다는 것이다.. 장고 쉘을 열어서 아래를 시도해보자.

from snippets.serializers import SnippetSerializer
serializer = SnippetSerializer()
print(repr(serializer))
# SnippetSerializer():
#    id = IntegerField(label='ID', read_only=True)
#    title = CharField(allow_blank=True, max_length=100, required=False)
#    code = CharField(style={'base_template': 'textarea.html'})
#    linenos = BooleanField(required=False)
#    language = ChoiceField(choices=[('Clipper', 'FoxPro'), ('Cucumber', 'Gherkin'), ('RobotFramework', 'RobotFramework'), ('abap', 'ABAP'), ('ada', 'Ada')...
#    style = ChoiceField(choices=[('autumn', 'autumn'), ('borland', 'borland'), ('bw', 'bw'), ('colorful', 'colorful')...

ModelSerializer 클래스가 마법을 부리지 않는다는 것을 기억해야한다. 그저 serializer 클래스를 생성하기 위한 지름길일 뿐이다.

• 자동적으로 필드들을 정의해준다.
• create()와 update() 메소드를 위한 기본 구현을 실행한다.

> Serializer 사용해서 장고 뷰 작성하기

이번에는 새로운 serializer 클래스를 사용해서 어떻게 API view를 작성할 수 있는지 알아보자.
REST Framework의 기능을 사용하지 않고, 기존의 장고 뷰를 작성할 것이다.

snippets/views.py 파일을 열어서 아래와 같이 수정하자.

from django.http import HttpResponse, JsonResponse
from django.views.decorators.csrf import csrf_exempt
from rest_framework.parsers import JSONParser
from snippets.models import Snippet
from snippets.serializers import SnippetSerializer

아래의 API가 존재하는 Snippet 클래스안의 모든 객체들을 리스팅해주거나 새로 생성해주는 view가 된다.

@csrf_exempt
def snippet_list(request):
    """
    List all code snippets, or create a new snippet.
    """
    if request.method == 'GET':
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return JsonResponse(serializer.data, safe=False)

    elif request.method == 'POST':
        data = JSONParser().parse(request)
        serializer = SnippetSerializer(data=data)
        if serializer.is_valid():
            serializer.save()
            return JsonResponse(serializer.data, status=201)
        return JsonResponse(serializer.errors, status=400)

여기서 CSRF 토큰을 가지고 있지 않을 클라이언트로부터 view를 POST 해야 하므로 csrf_exempt를 view에 기록해주어야한다.

또한, 각각의 snippet과 통신하고, 회수, 업데이트, 삭제하도록 사용할 수 있는 view가 필요하다.

@csrf_exempt
def snippet_detail(request, pk):
    """
    Retrieve, update or delete a code snippet.
    """
    try:
        snippet = Snippet.objects.get(pk=pk)
    except Snippet.DoesNotExist:
        return HttpResponse(status=404)

    if request.method == 'GET':
        serializer = SnippetSerializer(snippet)
        return JsonResponse(serializer.data)

    elif request.method == 'PUT':
        data = JSONParser().parse(request)
        serializer = SnippetSerializer(snippet, data=data)
        if serializer.is_valid():
            serializer.save()
            return JsonResponse(serializer.data)
        return JsonResponse(serializer.errors, status=400)

    elif request.method == 'DELETE':
        snippet.delete()
        return HttpResponse(status=204)

View를 연결하기위해 snippets/urls.py를 생성하자.

from django.urls import path
from snippets import views

urlpatterns = [
    path('snippets/', views.snippet_list),
    path('snippets/<int:pk>/', views.snippet_detail),
]

루트 urlconf도 수정해주어야 한다. tutorial/urls.py를 열어 snippet app URLs을 연결하자.

from django.urls import path, include

urlpatterns = [
    path('', include('snippets.urls')),
]

> API 테스트하기

시작하기 위해 장고 서버를 실행하자.

python manage.py runserver

curl이나 httpie를 이용해 API를 테스트 해보자. 아래서는 httpie를 사용할 것이다.

http http://127.0.0.1:8000/snippets/

HTTP/1.1 200 OK
...
[
  {
    "id": 1,
    "title": "",
    "code": "foo = \"bar\"\n",
    "linenos": false,
    "language": "python",
    "style": "friendly"
  },
  {
    "id": 2,
    "title": "",
    "code": "print(\"hello, world\")\n",
    "linenos": false,
    "language": "python",
    "style": "friendly"
  }
]

id로 접근해 특정한 snippet을 얻을 수도 있다.

http http://127.0.0.1:8000/snippets/2/

HTTP/1.1 200 OK
...
{
  "id": 2,
  "title": "",
  "code": "print(\"hello, world\")\n",
  "linenos": false,
  "language": "python",
  "style": "friendly"
}