mirror of
https://github.com/encode/django-rest-framework.git
synced 2025-08-04 12:30:11 +03:00
creating a method to return custom response data for generic views
This commit is contained in:
parent
1d34bc0b92
commit
39c7755a08
|
@ -11,7 +11,18 @@ from rest_framework.response import Response
|
|||
from rest_framework.settings import api_settings
|
||||
|
||||
|
||||
class CreateModelMixin(object):
|
||||
class BaseModelMixin(object):
|
||||
|
||||
def get_response_data(self, data, *args, **kwargs):
|
||||
"""
|
||||
Get the data to return as response data
|
||||
By default it returns `serializer.data`
|
||||
Override this method to return custom response data
|
||||
"""
|
||||
return data
|
||||
|
||||
|
||||
class CreateModelMixin(BaseModelMixin):
|
||||
"""
|
||||
Create a model instance.
|
||||
"""
|
||||
|
@ -20,7 +31,8 @@ class CreateModelMixin(object):
|
|||
serializer.is_valid(raise_exception=True)
|
||||
self.perform_create(serializer)
|
||||
headers = self.get_success_headers(serializer.data)
|
||||
return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
|
||||
response_data = self.get_response_data(serializer.data)
|
||||
return Response(response_data, status=status.HTTP_201_CREATED, headers=headers)
|
||||
|
||||
def perform_create(self, serializer):
|
||||
serializer.save()
|
||||
|
@ -32,7 +44,7 @@ class CreateModelMixin(object):
|
|||
return {}
|
||||
|
||||
|
||||
class ListModelMixin(object):
|
||||
class ListModelMixin(BaseModelMixin):
|
||||
"""
|
||||
List a queryset.
|
||||
"""
|
||||
|
@ -45,20 +57,22 @@ class ListModelMixin(object):
|
|||
return self.get_paginated_response(serializer.data)
|
||||
|
||||
serializer = self.get_serializer(queryset, many=True)
|
||||
return Response(serializer.data)
|
||||
response_data = self.get_response_data(serializer.data)
|
||||
return Response(response_data)
|
||||
|
||||
|
||||
class RetrieveModelMixin(object):
|
||||
class RetrieveModelMixin(BaseModelMixin):
|
||||
"""
|
||||
Retrieve a model instance.
|
||||
"""
|
||||
def retrieve(self, request, *args, **kwargs):
|
||||
instance = self.get_object()
|
||||
serializer = self.get_serializer(instance)
|
||||
return Response(serializer.data)
|
||||
response_data = self.get_response_data(serializer.data)
|
||||
return Response(response_data)
|
||||
|
||||
|
||||
class UpdateModelMixin(object):
|
||||
class UpdateModelMixin(BaseModelMixin):
|
||||
"""
|
||||
Update a model instance.
|
||||
"""
|
||||
|
@ -74,7 +88,8 @@ class UpdateModelMixin(object):
|
|||
# forcibly invalidate the prefetch cache on the instance.
|
||||
instance._prefetched_objects_cache = {}
|
||||
|
||||
return Response(serializer.data)
|
||||
response_data = self.get_response_data(serializer.data)
|
||||
return Response(response_data)
|
||||
|
||||
def perform_update(self, serializer):
|
||||
serializer.save()
|
||||
|
|
Loading…
Reference in New Issue
Block a user