Django REST Framework - Serializer & API

 

Serializer

 

 

출처: https://www.codingforentrepreneurs.com/courses/django-rest-framework-2022

Django REST Framework(DRF)의 Serializer는 데이터(모델 인스턴스, QuerySet 등)를 JSON 형식으로 변환(Serialize)하거나, JSON 데이터를 다시 모델 인스턴스로 변환(Deserialize)하는 역할을 합니다.

Serializer와 Deserializer

Serializer

• 모델 인스턴스나 QuerySet 데이터를 JSON 형식으로 변환
• 예: API 응답 데이터 생성

Deserializer

• JSON 데이터를 모델 인스턴스로 변환
• 예: 클라이언트 요청 데이터를 저장

---

Serializer 필드 매칭

Serializer는 유효성 검사를 거친 데이터를 기반으로 저장하며, 다음과 같은 방식으로 필드를 정의할 수 있습니다.

from rest_framework import serializers

class QuestionSerializer(serializers.Serializer):
    id = serializers.IntegerField(read_only=True)
    question_text = serializers.CharField(max_length=200)
    pub_date = serializers.DateTimeField(read_only=True)

    def create(self, validated_data):
        return Question.objects.create(**validated_data)
    
    def update(self, instance, validated_data):
        instance.question_text = validated_data.get('question_text', instance.question_text) + '[시리얼라이저에서 업데이트]'
        instance.save()
        return instance

---

Django Shell에서 Serializer 사용하기

(1) Serialize

from polls.models import Question
from polls_api.serializers import QuestionSerializer
from rest_framework.renderers import JSONRenderer

# 모델 인스턴스를 Serializer로 변환
q = Question.objects.first()
serializer = QuestionSerializer(q)
serializer.data  # Python Dictionary 형태

# JSON 파일 형식으로 변환
json_str = JSONRenderer().render(serializer.data)
json_str  # JSON 형식의 문자열 출력

(2) Deserialize

import json
from polls_api.serializers import QuestionSerializer

# JSON 문자열을 Python Dictionary로 변환
data = json.loads(json_str)

# Serializer를 사용하여 데이터 검증
serializer = QuestionSerializer(data=data)
serializer.is_valid()  # 유효성 검사
serializer.validated_data  # 유효한 데이터 확인

# 모델 인스턴스 저장 (Create)
new_question = serializer.save()

# Update 활용
update_data = {'question_text': '제목수정'}
serializer = QuestionSerializer(new_question, data=update_data)
serializer.is_valid()
serializer.save()  # 기존 데이터 업데이트

(3) Validation 실패 시 처리

long_text = "abcd" * 300  # 200자를 초과하는 텍스트
invalid_data = {'question_text': long_text}
serializer = QuestionSerializer(data=invalid_data)
serializer.is_valid()  # False 반환
serializer.errors  # 오류 메시지 출력

ModelSerializer 사용하기

기존 Serializer는 필드를 하나씩 지정해야 하지만, ModelSerializer를 사용하면 더 간결하게 정의할 수 있습니다.

from rest_framework import serializers
from polls.models import Question

class QuestionSerializer(serializers.ModelSerializer):
    class Meta:
        model = Question
        fields = ['id', 'question_text', 'pub_date']

ModelSerializer 검증

from polls_api.serializers import QuestionSerializer

serializer = QuestionSerializer(data={'question_text': 'ModelSerializer 예제'})
serializer.is_valid()
serializer.save()
Question.objects.all()  # 저장된 데이터 확인

---

 

Question 모델 API 구현

 

Django REST Framework 설정

• 먼저 rest_framework를 설치
• settings.py의 INSTALLED_APPS에 추가

INSTALLED_APPS = [
    ...
    'rest_framework',
    'polls_api',  # API를 구현할 앱
]

---

GET 요청: 전체 Question 조회

views.py

from rest_framework.decorators import api_view
from rest_framework.response import Response
from polls.models import Question
from polls_api.serializers import QuestionSerializer

@api_view(['GET'])
def question_list(request):
    questions = Question.objects.all()
    serializer = QuestionSerializer(questions, many=True)
    return Response(serializer.data)

urls.py

from django.urls import path
from .views import question_list

urlpatterns = [
    path('question/', question_list, name='question-list'),
]

Django 프로젝트의 urls.py에도 아래와 같이 포함해야 합니다.

from django.urls import include
path('rest/', include('polls_api.urls')),

---

POST 요청: Question 생성

views.py 수정

@api_view(['GET', 'POST'])
def question_list(request):
    if request.method == 'GET':
        questions = Question.objects.all()
        serializer = QuestionSerializer(questions, many=True)
        return Response(serializer.data)
    
    if request.method == 'POST':
        serializer = QuestionSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=201)  # HTTP 201 Created
        return Response(serializer.errors, status=400)  # HTTP 400 Bad Request

개별 Question 조회

views.py

from django.shortcuts import get_object_or_404

@api_view(['GET'])
def question_detail(request, id):
    question = get_object_or_404(Question, pk=id)
    serializer = QuestionSerializer(question)
    return Response(serializer.data)

urls.py

path('question/<int:id>/', question_detail, name='question-detail'),

---

PUT 요청: Question 수정

views.py

@api_view(['GET', 'PUT'])
def question_detail(request, id):
    question = get_object_or_404(Question, pk=id)
    
    if request.method == 'GET':
        serializer = QuestionSerializer(question)
        return Response(serializer.data)
    
    if request.method == 'PUT':
        serializer = QuestionSerializer(question, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=200)  # HTTP 200 OK
        return Response(serializer.errors, status=400)  # HTTP 400 Bad Request

---

DELETE 요청: Question 삭제

@api_view(['GET', 'PUT', 'DELETE'])
def question_detail(request, id):
    question = get_object_or_404(Question, pk=id)
    
    if request.method == 'DELETE':
        question.delete()
        return Response(status=204)  # HTTP 204 No Content

---

HTTP 상태 코드

• 200 OK: 요청이 성공적으로 처리됨
• 201 CREATED: 새로운 리소스 생성
• 204 NO CONTENT: 삭제 성공
• 400 BAD REQUEST: 잘못된 요청
• 404 NOT FOUND: 리소스를 찾을 수 없음