Renderer

💡 Renderer

Renderer를 같은 Endpoint에 대해서 동일한 로직으로 데이터를 처리 하고 나서

최종적으로 응답을 줄 때에 어떤 응답 포맷으로 처리할 것인지를 나타낸다.

Content-Type, URL의 방법을 통해서 Renderer 지정 가능하다.

💡 기본 지원 되는 Renderer

1. JSONRenderer (default 지정)

▪ media_type → application/json → json

json.dumps를 통한 JSON 직렬화

2. BrowsableAPIRenderer (default 지정)

▪ media_type → text/html, format → api

self-document HTML 렌더링

3. Template(HTML)Renderer

▪ media_type → text/html, format → api

지정 템플릿을 통한 렌더링

Response에서 template_name 인자 지정 필요

API 서버라고 해서 모든 응답을 JSON으로 받지 않아도, 경우에 따라서 HTML응답을 받을 수도 있다.

class PostDetailAPIView(RetrieveAPIView):
    queryset = Post.objects.all()
    renderer_template = [TemplateHTMLRender]
    template_name = 'instagram/post_detail.html'

    """
    template_name은 여기에 선언해도 되고,

    또는 get함수의 kwargs로 넘겨도 상관없다.
    """

    def get(self, request, *args, **kwargs):
        post = self.get_object()

        return Response({
            'post':PostSerializer(post).data
        })

위 코드에서 get_object()는 RetrieveAPIView 클래스 내부에 구현되어 있다.

그리고 kwargs에서 ‘post’:PostSerializer(post).data 같이 넘겨주게 되면

아래와 같은 결과를 반환해준다.

반면에 그냥 post만 넘겨주게 된다면, 아래와 같은 결과를 볼 수 있다.

💡 다양한 Renderer

StaticRenderer

미리 렌더링된 HTML을 반환한다.

아래와 같이, Response객체 생성시에 HTML문자열을 직접 지정해 준다.

@api_view(['GET'])
@renderer_classes([StaicHTMLRenderer])
def static_view(request):
    html = """<html><body>example</body><html>"""
    return Response(html)

이 외에도 AdminRenderer, HTMLFormRenderer, MultiPartRenderer등이 지원된다.

💡 Renderer 클래스 리스트 지정하기

1. 전역 지정 (추천 ✔)

settings > REST_FRAMEWORK > DEFAULT_RENDERER_CLASSES 리스트에 문자열로 지정.

▪ rest_framework/settings.py

2. APIView 마다 지정

queryset, serializer_class와 더불어, renderer_classes 리스트

3. @api_view 마다 지정

별도의 renderer_classes 장식자가 있다.

💡 Renderer 응답 포맷

1. 두 가지 유형의 응답 포맷

▪ api : API EndPoint에 브라우저를 통해 접근할 때, 웹 UI로 조회 가능

http://127.0.0.1:8000/post/1.api

http://127.0.0.1:8000/post/1/?format=api

▪ json : 보통의 API접근

http://127.0.0.1:8000/post/1.json

http://127.0.0.1:8000/post/1/?format=json

2. 응답 포맷은 어떻게 결정되는가?

Accept 헤더

• Accept: application/json

• Accept: text/html

GET인자 format

• ?format=json

• ?format=api

URL Captured Values에서의 format 인자

• .json

• .api

💡 URL Captured Values에서의 format 인자

router를 사용할 경우 아래와 같이 format 인자를 기본적으로 지원해준다.

<URLPattern '^post\.(?P<format>[a-z0-9]+)/?$' [name='post-list']>

반면에 개발자가 “함수기반 view”를 구현할 경우에는 필히 URLPatterns에 지정된

format=None을 kwargs로 넘겨줘야한다.

“클래스 기반 view”는 크게 문제가 되는 부분이 없다.

None으로 넘겨주는 이유는 format이 없을 경우를 대비해 default값을 지정해 주는 것이다.

# views.py
from rest_framework.decorators import api_view

@api_view(['GET'])
def hello(request, format=None):
    return Response([])

아래 코드는 그리고 router를 사용하지 않고, format 인자를 URLPatterns에 선언하는 방법이다.

# urls.py
from rest_framework.url.patterns import format_surfix_patterns

urlpatterns = format_suffix_patterns([
    paht('hello/', views.hello)
])

생성된 URLPatterns는 다음과 같다.

[
    <URLPatterns 'hello'/>,
    <URLPaatters 'hello<drf_format_suffix:format>'>
]