View

• Django에서는 View를 통해서 HTTP 요청을 처리
• View에서 요청을 처리하는 방법은 다양함
  • CBV(클래스 기반 뷰), FBV(함수 기반 뷰)를 통해서도 API를 만들 수 있지만 REST framework에서는 보다 쉽고 효율적으로 만들 수 있음

APIView 클래스와 api_view 장식자

• APIView와 api_view는 각각 CBV와 FBV에 대응되는 내용
• 두 가지 모두 View에 여러 가지 기본 설정을 부여하게 되는데 상황에 맞춰서 커스튬하여 사용

• 직렬화 클래스 지정
  • renderer_classes
  • default
    • JSON 직렬화 : rest_framework.renderers.JSONRenderer
    • HTML 페이지 직렬화 : rest_framework.renderers.TemplateHTMLRenderer
• 비직렬화 클래스 지정
  • parser_classes
  • default
    • JSON 포맷 처리 : rest_framework.parsers.JSONParser
    • FormParser : rest_framework.parsers.FormParser
    • MultiPartParser : rest_framework.parsers.MultiPartParser
• 인증 클래스 지정
  • authentication_classes
  • default
    • 세션기반인증 : rest_framework.authentication.SessionAuthentication
    • HTTP basic 인증 : rest_framework.authentication.BasicAuthentication
• 사용량 제한 클래스 지정
  • throttle_classes
  • default
    • 빈 튜플
• 권한 클래스 지정
  • permission_classes
  • default
    • 누구라도 접근 허용 : rest_framework.permissions.AllowAny
• 요청에 따라 적절한 직렬화/비직렬화 선택
  • content_negotiation_class
  • 같은 URL 요청에 대해서 JSON 응답을 할 지, HTML 응답을 할 지 판단
  • default
    • rest_framework.negotiation.DefaultContentNegotiation
• 요청 내역에서 API 버전 정보를 탐지할 클래스 지정
  • versioning_class
  • 요청 URL의 HEADER에서 버전 정보를 탐지하여 맞는 버전을 호출
  • default
    • 버전 정보를 탐지하지 않습니다. : None

APIView

• CBV 중 하나이기 때문에 하나의 URL에 대해서만 처리를 할 수 있음
  • /article/에 대한 CBV
    • get : article 목록
    • post : 새 article 생성
  • /article/<int:pk>/에 대한 CBV
    • get : pk번 article 내용
    • put : pk번 article 수정
    • delete : pk번 article 삭제

• 요청 method에 맞게 멤버 함수를 정의하면 해당 method 로 request가 들어올 때 호출하게 됨

def get(self, request): 
    pass 

def post(self, request): 
    pass 
    
def put(self, request): 
    pass 

def delete(self, request): 
    pass

Tip! 멤버 함수
클래스의 내부에서 정의된 함수를 멤버 함수(member function)라고 하며, 때로는 메소드(method)라고 불리기도 함

• 각 method가 호출되면 위에서 봤던 설정에 맞춰 처리가 이루어짐
  • 직렬화/비직렬화
  • 인증 확인
  • 사용량 제한 확인
  • 권한 확인
  • 요청한 버전 확인

# views.py

class ArticleListCreateAPIView(APIView):

    def get(self, request):
        articles = Article.objects.filter(active=True)
        serializer = ArticleSerializer(articles, many=True)
        return Response(serializer.data)      

    def post(self, request):
        serializer = ArticleSerializer(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 ArticleDetailAPIView(APIView):

    def get_object(self, pk):
        article = get_object_or_404(Article, pk=pk)
        return article

    def get(self, request, pk):
        article = self.get_object(pk)
        serializer = ArticleSerializer(article)
        return Response(serializer.data)

    def put(self, request, pk):
        article = self.get_object(pk)
        serializer = ArticleSerializer(article, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

    def delete(self, request, pk):
        article = self.get_object(pk)
        article.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

def get_object(self, pk):
    article = get_object_or_404(Article, pk=pk)
    return article

# urls.py

urlpatterns = [
    path("articles/", 
         ArticleListCreateAPIView.as_view(), 
         name="article-list"),

    path("articles/<int:pk>/", 
         ArticleDetailAPIView.as_view(), 
         name="article-detail"),
 ]

• 각 클래스에 대해 .as_view()로 라우팅을 해주면 View에서 이들을 불러와 요청을 처리를 해주게 됨

@api_view

• api_view는 FBV에 대해서 사용하는 장식자

# views.py

@api_view(["GET", "POST"])
def article_list_create_api_view(request):

    if request.method == "GET":
        articles = Article.objects.filter(active=True)
        serializer = ArticleSerializer(articles, many=True)
        return Response(serializer.data)

    elif request.method == "POST":
        serializer = ArticleSerializer(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 article_detail_api_view(request, pk):
    try:
        article = Article.objects.get(pk=pk)
    except Article.DoesNotExist:
        return Response({"error": {
                            "code": 404,
                            "message": "Article not found!"
                        }}, status=status.HTTP_404_NOT_FOUND)
    
    if request.method == "GET":
        serializer = ArticleSerializer(article)
        return Response(serializer.data)
    
    elif request.method == "PUT":
        serializer = ArticleSerializer(article, 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":
        article.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

try:
    article = Article.objects.get(pk=pk)
except Article.DoesNotExist:
    return Response({"error": {
                        "code": 404,
                        "message": "Article not found!"
                    }}, status=status.HTTP_404_NOT_FOUND)

# urls.py

urlpatterns = [
    path("articles/",
         article_list_create_api_view,
         name="article-list"),
         
    path("articles/<int:pk>/", 
         article_detail_api_view,
         name="article-detail")
]

Mixin

• APIView는 각 request method 마다 직접 serializer 처리를 해주어야 하는데 이 과정에서 여러 serializer에 대해 중복이 발생하게 됨
• rest_framework.mixins에서는 이러한 기능들이 미리 구현이 되어 있음
  • CreateModelMixin
  • ListModelMixin
  • RetrieveModelMixin
  • UpdateModelMixin
  • DestroyModelMixin
• queryset과 serializer_class를 지정해주기만 하면 나머지는 상속 받은 Mixin과 연결됨

# views.py

class EbookListCreateAPIView(mixins.ListModelMixin,
                             mixins.CreateModelMixin,
                             generics.GenericAPIView):

    queryset = Ebook.objects.all()
    serializer_class = EbookSerializer

    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 EbookDetailMixins(mixins.RetrieveModelMixin,
                        mixins.UpdateModelMixin,
                        mixins.DestroyModelMixin,
                        generics.GenericAPIView):
                        
    queryset = Ebook.objects.all()
    serializer_class = EbookSerializer

    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.delete(request, *args, **kwargs)

# urls.py

urlpatterns = [
    path("ebooks/", 
         EbookListCreateAPIView.as_view(), 
         name="ebook-list"),

    path("ebooks/<int:pk>/", 
         EbookDetailAPIView.as_view(), 
         name="ebook-detail"),
]

Tip! GenericAPIView
GenericAPIView에서는 lookup_field='pk'를 default로 갖고 있음

Concrete View Classes

• Mixin을 상속함으로서 반복되는 내용을 많이 줄일 수 있음
• 하지만 여러 개를 상속해야 하다보니 가독성이 떨어짐
• REST Framework에서는 Mixin을 상속한 새로운 클래스가 정의되어 있음

• 총 9개의 클래스
  • generics.CreateAPIView : 생성
  • generics.ListAPIView : 목록
  • generics.RetrieveAPIView : 조회
  • generics.DestroyAPIView : 삭제
  • generics.UpdateAPIView : 수정
  • generics.RetrieveUpdateAPIView : 조회/수정
  • generics.RetrieveDestroyAPIView : 조회/삭제
  • generics.ListCreateAPIView : 목록/생성
  • generics.RetrieveUpdateDestroyAPIView : 조회/수정/삭제

# views.py

class EbookListCreateAPIView(generics.ListCreateAPIView):
    queryset = Ebook.objects.all().order_by("id")
    serializer_class = EbookSerializer


class EbookDetailAPIView(generics.RetrieveUpdateDestroyAPIView):
    queryset = Ebook.objects.all()
    serializer_class = EbookSerializer

# urls.py

urlpatterns = [
    path("ebooks/", 
         EbookListCreateAPIView.as_view(), 
         name="ebook-list"),

    path("ebooks/<int:pk>/", 
         EbookDetailAPIView.as_view(), 
         name="ebook-detail"),
]

ViewSet

• generics.APIView를 통해서 코드를 많이 간소화 하였지만 아직 queryset과 serializer_class가 공통적인데도 불구하고 따로 기재해주어야했음
• 이를 한 번에 처리해주는게 바로 ViewSet

• ViewSet은 CBV가 아닌 헬퍼 클래스로 두 가지 종류가 있음
  • viewsets.ReadOnlyModelViewSet : 목록 조회, 특정 레코드 조회
  • viewsets.ModelViewSet : 목록 조회, 특정 레코드 생성/조회/수정/삭제

• ViewSet의 두 종류 모두 자체적인 구현은 없고 Mixin을 적절히 상속 받아 여러 기능을 수행
  • viewsets.ReadOnlyModelViewSet
    • 목록 조회
      • mixins.ListModelMixin : list() 함수
    • 특정 레코드 조회
      • mixins.RetrieveModelMixin : retrieve() 함수
  • viewsets.ModelViewSet
    • 목록 조회
      • mixins.ListModelMixin : list() 함수
    • 특정 레코드 조회
      • mixins.RetrieveModelMixin : retrieve() 함수
    • 특정 레코드 생성
      • mixins.CreateModelMixin : create() 함수
    • 특정 레코드 수정
      • mixins.UpdateModelMixin : update() 함수, partial_update() 함수
      • partial_update(): 부분적인 필드 값만 받아 수정이 가능하며 request method 중 Fetch와 대응됨
    • 특정 레코드 삭제
      • mixins.DestroyModelMixin : destroy() 함수