[프로그래머스] 데브코스 데이터엔지니어링 TIL Day 13

주재민·2023년 11월 1일

KDT TIL django python 데브코스 데이터 엔지니어 데이터 엔지니어링 장고 파이썬 프로그래머스

[데브코스] 데이터 엔지니어링

목록 보기

14/73

📖 학습주제

파이썬 장고 프레임웍을 사용해서 API 서버 만들기(3)

Serilaizer

시리얼라이저란 아래의 두 작업을 모두 수행할 수 있는 모델이다.

Serilaize

모델 인스턴스나 QuerySet과 같은 데이터들을 JSON형식의 파일로 변환하는 작업

Deserilaize

JSON형식의 파일을 J모델 인스턴스나 QuerySet과 같은 데이터들로 변환하는 작업

시리얼라이저를 구현할 새로운 앱을 작성한다.

python manage.py startapp polls_api

시리얼라이즈 하기 위해서는 각 필드들을 매칭해줘야 한다.

시리얼라이저는 생성시 유효성검사를 통과한 데이터를 기반으로 생성하며 통과한 데이터는 validated_data로 주어짐

polls_api/serializers.py

from rest_framework import serializers
from polls.models import Question

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

create() : 받은 정보를 저장

update() : 기존의 것을 업데이트(create는 없던 것을 생성)
-> 기존의 데이터를 받음

Django Shell에서 Serializer 사용하기

Django Shell에서 Serializer 사용해보자

Django Shell

>>> from polls.models import Question
>>> from polls_api.serializers import QuestionSerializer
>>> q = Question.objects.first()
>>> q 
<Question: 제목: 휴가를 어디서 보내고 싶으세요?, 날짜: 2023-02-05 18:52:59+09:00>
>>> serializer = QuestionSerializer(q)
>>> serializer.data
{'id': 1, 'question_text': '휴가를 어디서 보내고 싶으세요?', 'pub_date': '2023-02-05T18:52:59Z'}
>>> from rest_framework.renderers import JSONRenderer
>>> json_str = JSONRenderer().render(serializer.data)
>>> json_str
b'{"id":1,"question_text":"\xed\x9c\xb4\xea\xb0\x80\xeb\xa5\xbc \xec\x96\xb4\xeb\x94\x94\xec\x84\x9c \xeb\xb3\xb4\xeb\x82\xb4\xea\xb3\xa0 \xec\x8b\xb6\xec\x9c\xbc\xec\x84\xb8\xec\x9a\x94?","pub_date":"2023-02-05T18:52:59Z"}'

# Deserialize
>>> import json
>>> data = json.loads(json_str)
>>> data
{'id': 1, 'question_text': '휴가를 어디서 보내고 싶으세요?', 'pub_date': '2023-02-05T18:52:59Z'}
>>> serializer = QuestionSerializer(data=data)
>>> serializer.is_valid()  
True
>>> serializer.validated_data 
OrderedDict([('question_text', '휴가를 어디서 보내고 싶으세요?')])
>>> new_question = serializer.save() # Create
>>> new_question
<Question: 제목: 휴가를 어디서 보내고 싶으세요?, 날짜: 2023-02-14 18:46:56.209215+00:00>
>>> data={'question_text': '제목수정'}
>>> serializer = QuestionSerializer(new_question, data=data) 
>>> serializer.is_valid()  
True
>>> serializer.save() # Update
<Question: 제목: 제목수정[시리얼라이저에서 업데이트], 날짜: 2023-04-25 13:15:05.852404+00:00>

#Validation이 통과하지 않는 경우
>>> long_text = "abcd"*300
>>> data = {'question_text':long_text}
>>> serializer = QuestionSerializer(data=data)
>>> serializer.is_valid()
False
>>> serializer.errors
{'question_text': [ErrorDetail(string='Ensure this field has no more than 200 characters.', code='max_length')]}

ModelSerializer

ModelSerializer를 이용하면 필드를 하나하나 정의하지 않아도 되고 create(), `update()' 또한 만들지 않아도 돼 편리하다.

polls_api/serializers.py

from rest_framework import serializers
from polls.models import Question

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

HTTP Methods

CRUD

데이터의 생성(Create), 읽기(Read), 수정(Update), 삭제(Delete)를 나타내는 약어로, 대부분의 소프트웨어 시스템에서 필요한 가장 기본적인 데이터 조작 기능을 의미한다.

CRUD를 구현하는 HTTP Methods는 다음과 같다.

데이터 생성(Create) : POST
데이터 조회(Read) : GET
데이터 업데이트(Update) : PUT
데이터 삭제(Delete) : DELETE
(정보를 획득할 때는 get(), 정보를 서버에 표현할 때는 post())

참고
https://developer.mozilla.org/ko/docs/Web/HTTP/Methods

mysite/urls.py

from django.urls import include, path
from django.contrib import admin

urlpatterns = [
    path('admin/', admin.site.urls),
    path('polls/', include('polls.urls')),
    path('rest/', include('polls_api.urls')),
]

polls_api/views.py

from rest_framework.decorators import api_view
from polls.models import Question
from polls_api.serializers import QuestionSerializer
from rest_framework.response import Response
from rest_framework import status
from django.shortcuts import get_object_or_404

# question 여러개
@api_view(['GET','POST']) # 따로 지정안하면 get 지정
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=status.HTTP_201_CREATED)
        else:
            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
     
# question 한 개
@api_view(['GET', 'PUT', 'DELETE'])
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=status.HTTP_200_OK)
        else:    
            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

    if request.method == 'DELETE':
        question.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

path를 추가하자.

polls_api/urls.py

from django.urls import path
from .views import *

urlpatterns = [
    path('question/', question_list, name='question-list'),
    path('question/<int:id>/', question_detail, name='question-detail')
]

Class 기반의 뷰(Views)

polls_api/views.py

from rest_framework.views import APIView

class QuestionList(APIView):
    def get(self, request):
        questions = Question.objects.all()
        serializer = QuestionSerializer(questions, many=True)
        return Response(serializer.data)

    def post(self, request):
        serializer = QuestionSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

class QuestionDetail(APIView):
    def get(self, request, id):
        question = get_object_or_404(Question, pk=id)
        serializer = QuestionSerializer(question)
        return Response(serializer.data)

    def put(self, request, id):
        question = get_object_or_404(Question, pk=id)
        serializer = QuestionSerializer(question, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_200_OK)
        else:    
            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
        
    def delete(self, request, id):
        question = get_object_or_404(Question, pk=id)
        question.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

path를 추가하자.

polls_api/urls.py

from django.urls import path
from .views import *

urlpatterns = [
    path('question/', QuestionList.as_view(), name='question-list'),
    path('question/<int:id>/', QuestionDetail.as_view(), name='question-detail'),
]

클래스 기반의 장점

데코레이터 없이 메소드로 구현 가능하며 분기문을 쓰는 것보다 코드가 깔끔하다.

Django의 rest_framework이 제공하는 다양한 클래스를 이용해 더 간단하게 구현해보자

Mixin

polls_api/views.py

from polls.models import Question
from polls_api.serializers import QuestionSerializer
from rest_framework import mixins

class QuestionList(mixins.ListModelMixin,
                  mixins.CreateModelMixin,
                  generics.GenericAPIView):
    queryset = Question.objects.all()
    serializer_class = QuestionSerializer

    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)

class QuestionDetail(mixins.RetrieveModelMixin,
                    mixins.UpdateModelMixin,
                    mixins.DestroyModelMixin,
                    generics.GenericAPIView):
    queryset = Question.objects.all()
    serializer_class = QuestionSerializer

    def get(self, request, *args, **kwargs):
        return self.retrieve(request, *args, **kwargs)

    def put(self, request, *args, **kwargs):
        return self.update(request, *args, **kwargs)

    def delete(self, request, *args, **kwargs):
        return self.destroy(request, *args, **kwargs)

path를 추가하자.

polls_api/urls.py

from django.urls import path
from .views import *

urlpatterns = [
    path('question/', QuestionList.as_view(), name='question-list'),
    path('question/<int:pk>/', QuestionDetail.as_view(), name='question-detail'),
]

Generic API View

polls_api/views.py

from polls.models import Question
from polls_api.serializers import QuestionSerializer
from rest_framework import generics

class QuestionList(generics.ListCreateAPIView):
    queryset = Question.objects.all()
    serializer_class = QuestionSerializer

class QuestionDetail(generics.RetrieveUpdateDestroyAPIView):
    queryset = Question.objects.all()
    serializer_class = QuestionSerializer

주재민

이전 포스트

[프로그래머스] 데브코스 데이터엔지니어링 TIL Day 12

다음 포스트

[프로그래머스] 데브코스 데이터엔지니어링 TIL Day 13

[데브코스] 데이터 엔지니어링

📖 학습주제

Serilaizer

Serilaizer

Serilaize

Deserilaize

polls_api/serializers.py

Django Shell에서 Serializer 사용하기

Django Shell

ModelSerializer

polls_api/serializers.py

HTTP Methods

CRUD

mysite/urls.py

polls_api/views.py

polls_api/urls.py

Class 기반의 뷰(Views)

polls_api/views.py

polls_api/urls.py

클래스 기반의 장점

Mixin

polls_api/views.py

polls_api/urls.py

Generic API View

polls_api/views.py

[프로그래머스] 데브코스 데이터엔지니어링 TIL Day 12

[프로그래머스] 데브코스 데이터엔지니어링 TIL Day 14

0개의 댓글