Django REST Framework

Django REST Framework

일반적으로 DRF 라고 줄여서 부르는 Django REST Framework는 Django 안에서 REST 아키텍처에 따라 GET, POST, PUT , DELETE 등 HTTP 메소드를 사용한 RESTful API 서버를 쉽게 구축할 수 있도록 도와주는 오픈소스 라이브러리입니다.

REST API

• REST는 “Representational State Transfer”의 약자로 자원을 이름으로 구분하여 해당 자원의 상태를 주고 받도록 하는 아키텍처 스타일을 의미합니다. REST는 HTTP 프로토콜을 활용하기 때문에 웹의 장점을 그대로 활용할 수 있게 합니다.

• API는 “Application Programming Interface, 응용 프로그래밍 인터페이스”로 간단하게 하나의 프로그램 혹은 시스템에 또 다른 프로그램이 연결하여 기능을 응용하여 사용할 수 있도록 해주는 인터페이스를 의미합니다.

  ⇒ 즉, REST API는 REST 아키텍처를 이용해서 자원을 주고받을 수 있도록 만들어진 API라고 볼 수 있습니다.

기존의 Django 구조에는 Template이 포함되어 있어 클라이언트의 요청에 따라 처리한 결과를 html 페이지로 렌더링하여 보여주게 되어있습니다. 하지만 최근에는 비즈니스의 구조가 복잡해지고 이에 따라 서비스의 형태도 다양해지면서 프론트엔드와 백엔드가 분리되고 html로 렌더링하는 웹 서버 대신 JSON 또는 XML과 같은 형식으로 데이터를 다루는 API 서버의 필요성이 높아졌습니다.

그래서 Django 웹 프레임워크의 기능을 그대로 사용하면서도 웹 브라우저 뿐만아니라 스마트폰, 태블릿 등의 어플리케이션에도 범용적으로 사용 가능한 REST API를 만들기 위해 DRF가 사용됩니다.

Serializer

시리얼라이저는 DRF에서 새롭게 추가된 개념입니다. REST API에서는 정보를 JSON 또는 XML 형태로 주고 받기 때문에 model로부터 주고받는 객체 정보도 JSON 혹은 딕셔너리 형태로 바꿔줘야합니다. 그러기 위해서 시리얼라이저를 통해 정보를 “직렬화” 해주는 과정이 필요하며, 이는 DRF가 제공하는 Serializer 클래스를 이용하면 됩니다.

예시)

from rest_framework import serializers

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

DRF View 작성법

— DRF에서의 View 작성법은 기존 Django에서 View를 작성하는 방법과 크게 다르지 않습니다. 다만 DRF 만의 별도 모듈 혹은 클래스들이 존재하기 때문에 이를 활용하는 방법을 파악해야합니다.

FBV

함수형 뷰로 REST API를 구현하고 싶은 경우 기존 Django 함수형 뷰에 api_view 데코레이터를 추가하면 됩니다. 추가로 함수 안에 Serializer 객체 선언을 필요로 합니다.

예시)

from rest_framework import status
from rest_framework.decorators import api_view
from rest_framework.response import Response
from snippets.models import Snippet
from snippets.serializers import SnippetSerializer

@api_view(['GET', 'POST'])
def snippet_list(request):
    if request.method == 'GET':
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return Response(serializer.data)

    elif request.method == 'POST':
        serializer = SnippetSerializer(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)

CBV

• APIView 클래스 사용

  APIView는 Django의 View 클래스와 거의 동일한 방식으로 사용할 수 있습니다.

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from django.http import Http404
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status

class SnippetList(APIView):
    def get(self, request, format=None):
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return Response(serializer.data)

    def post(self, request, format=None):
        serializer = SnippetSerializer(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)

• Mixin을 사용한 CBV

  GenericAPIView 클래스를 기반으로 다중상속을 통해 필요한 기능을 조합해서 사용이 가능합니다.

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework import mixins
from rest_framework import generics

class SnippetList(mixins.ListModelMixin,
                  mixins.CreateModelMixin,
                  generics.GenericAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

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

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

• Generic Class-based View

  Generic 클래스를 기반으로 일반적으로 많이 사용되는 기능들이 이미 믹스인 되어있는 클래스들을 사용할 수도 있습니다. Generic 기반 클래스를 사용할 경우 아래와 같이 같은 기능을 만들더라도 코드 길이를 크게 줄일 수 있습니다.

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework import generics

class SnippetList(generics.ListCreateAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer