2022-03-02::DRF Requests and Responses

Request Objects

DRF는 기존 HttpRequest에서 발전된 형태인 Request객체를 제공한다. 이 새로운 객체는 HttpRequest객체 보다 더 유연한 request 파싱 기능을 제공한다. Request객체의 가장 중요한 기능 중 하나는 request.data 속성이다. request.POST가 POST 요청에만 유효한 반면 request.data는 PUT, PATCH 메서드에도 유효하다.

Response Objects

DRF는 TemplateResponse의 한 종류인 Response객체도 제공한다.

Status Codes

HTTP status code를 숫자로 일일히 입력하는 것은 직관적이지 못하다. DRF의 status 모듈 안에는 HTTP_400_BAD_REQUEST와 같은 직관적인 status code가 포함되어 있다.

Wrapping API views

DRF는 API views를 작성할 때 사용할 수 있는 두 가지 Wrappers를 제공한다.

1. @api_view 데코레이터는 함수 기반 뷰에 사용된다.

2. APIView 클래스는 클래스 기반 뷰에 사용된다.

이 래퍼들은 view에서 Request 인스턴스를 받았는지 검증하고 content negotiation이 작동하도록 Response객체에 context를 추가한다.

또한 래퍼들은 필요할 때 status code를 리턴하거나 잘못된 form 형태로 request.data를 접근할 때 ParseError를 발생시킨다.

content negotiation

https://www.django-rest-framework.org/api-guide/content-negotiation/

Pulling it all together

위 기능들을의 사용 예시는 아래와 같다. views.py

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):
    """
    List all code snippets, or create a new snippet.
    """
    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)

 

@api_view(['GET', 'PUT', 'DELETE'])
def snippet_detail(request, pk):
    """
    Retrieve, update or delete a code snippet.
    """
    try:
        snippet = Snippet.objects.get(pk=pk)
    except Snippet.DoesNotExist:
        return Response(status=status.HTTP_404_NOT_FOUND)

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

    elif request.method == 'PUT':
        serializer = SnippetSerializer(snippet, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

    elif request.method == 'DELETE':
        snippet.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

urls.py

from django.urls import path
from rest_framework.urlpatterns import format_suffix_patterns
from snippets import views

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

urlpatterns = format_suffix_patterns(urlpatterns)