[python] Django REST framework에서의 시리얼라이저와 디시리얼라이저 작성 방법

29 Nov 2023

python

Django REST Framework은 웹 API를 쉽게 만들고 관리할 수 있는 도구입니다. 이를 통해 손쉽게 데이터의 시리얼라이즈와 디시리얼라이즈를 처리할 수 있습니다.

시리얼라이저(Serializer)란?

시리얼라이저는 Django의 Model 인스턴스나 QuerySet과 같은 복잡한 데이터 타입을 JSON, XML 또는 다른 적절한 포맷으로 변환하는 역할을 합니다. 시리얼라이저는 모델의 필드를 직렬화하고 반환하며, 필요한 경우 유효성 검사도 수행할 수 있습니다.

시리얼라이저를 작성하기 위해서는 다음과 같은 단계를 따릅니다:

serializers 모듈을 임포트합니다.
시리얼라이저 클래스를 작성합니다.
시리얼라이저 클래스 안에 모델 필드를 선언합니다.

아래는 예제입니다:

from rest_framework import serializers
from .models import MyModel

class MyModelSerializer(serializers.Serializer):
    field1 = serializers.CharField(max_length=100)
    field2 = serializers.IntegerField()

디시리얼라이저(Deserializer)란?

디시리얼라이저는 시리얼라이저의 반대 작업을 수행합니다. 즉, JSON, XML 등과 같은 데이터를 Django의 Model 인스턴스로 변환합니다. 디시리얼라이저는 클라이언트로부터 수신한 데이터의 유효성을 검사하고, 필요한 경우 데이터를 역직렬화하여 Django 모델과 일치하는 인스턴스를 생성합니다.

디시리얼라이저를 작성하기 위해서는 다음과 같은 단계를 따릅니다:

serializers 모듈을 임포트합니다.
디시리얼라이저 클래스를 작성합니다.
디시리얼라이저 클래스 안에 모델과 필드를 선언합니다.

아래는 예제입니다:

from rest_framework import serializers
from .models import MyModel

class MyModelDeserializer(serializers.Serializer):
    field1 = serializers.CharField(max_length=100)
    field2 = serializers.IntegerField()

    def create(self, validated_data):
        return MyModel.objects.create(**validated_data)

    def update(self, instance, validated_data):
        instance.field1 = validated_data.get('field1', instance.field1)
        instance.field2 = validated_data.get('field2', instance.field2)
        instance.save()
        return instance

시리얼라이저와 디시리얼라이저는 Django REST Framework에서 데이터의 변환과 유효성 검사를 담당하는 중요한 요소입니다. 올바르게 작성하면 강력하고 유연한 웹 API를 구축할 수 있습니다.

더 자세한 내용은 Django REST Framework 공식 문서를 참고하시기 바랍니다.

참고 자료

Django REST Framework 공식 문서: https://www.django-rest-framework.org/