Viewsets in rest framework

ViewSets in Django Rest Framework (DRF) are a convenient way to organize logic for handling API endpoints related to a particular model or resource. They allow you to group common views (GET, POST, PUT, DELETE) for a model into a single class, reducing code duplication and making your codebase more maintainable. Here’s a comprehensive guide on how to use ViewSets in DRF:

Types of ViewSets in DRF

  1. ModelViewSet: Provides default CRUD (Create, Retrieve, Update, Delete) operations for a Django model. It combines ListAPIView, CreateAPIView, RetrieveAPIView, UpdateAPIView, and DestroyAPIView into a single class.
  2. ReadOnlyModelViewSet: Similar to ModelViewSet but excludes the Create and Update operations. It provides only List, Retrieve, and Destroy operations.
  3. ViewSet: A base class that provides the actions (methods) for handling requests, but doesn't include any method handlers (like list(), create(), etc.) by default. It's used when you want to define custom actions beyond the standard CRUD operations.

Creating a ModelViewSet

  1. Define Serializer: Create a serializer to specify how data should be serialized and deserialized for your model.
    # serializers.py
from rest_framework import serializers
from .models import MyModel

class MyModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = MyModel
        fields = '__all__'
  2. Define ViewSet: Create a ViewSet class using ModelViewSet or ReadOnlyModelViewSet.
    # views.py
from rest_framework import viewsets
from .models import MyModel
from .serializers import MyModelSerializer

class MyModelViewSet(viewsets.ModelViewSet):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer
    • queryset: Specifies the queryset of objects that this ViewSet will operate on.
    • serializer_class: Specifies the serializer class to use for serializing and deserializing data.
  3. Register ViewSet with Router: Use a Router to automatically configure the URL patterns for your ViewSet.
    # urls.py
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import MyModelViewSet

router = DefaultRouter()
router.register(r'mymodels', MyModelViewSet)

urlpatterns = [
    path('api/', include(router.urls)),
    # other paths
]
    • router.register(): Registers the ViewSet with a URL prefix (r'mymodels' in this case).

Customizing ViewSets

  1. Override Methods: Customize behavior by overriding methods in your ViewSet class.
    class MyModelViewSet(viewsets.ModelViewSet):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer

    def perform_create(self, serializer):
        # Customize create operation
        serializer.save(owner=self.request.user)
    • perform_create(): Override to customize object creation logic.
  2. Adding Custom Actions: Define custom actions beyond standard CRUD operations.
    class MyModelViewSet(viewsets.ModelViewSet):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer

    @action(detail=True, methods=['post'])
    def custom_action(self, request, pk=None):
        # Custom action logic
        instance = self.get_object()
        # Perform custom action
        return Response({'status': 'custom action completed'}, status=status.HTTP_200_OK)
    • @action(): Decorator to define custom actions (detail=True indicates action operates on a single object).

Using ViewSets in URLs

  1. Include ViewSet URLs: Include the generated URL patterns for ViewSets in your Django project’s URL configuration.
    # urls.py
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import MyModelViewSet

router = DefaultRouter()
router.register(r'mymodels', MyModelViewSet)

urlpatterns = [
    path('api/', include(router.urls)),
    # other paths
]
    • include(router.urls): Includes all generated URL patterns for registered ViewSets (/api/mymodels/, /api/mymodels/{pk}/, etc.).

Conclusion

ViewSets in Django Rest Framework provide a structured way to organize and handle API views related to Django models. Whether you’re creating simple CRUD operations or defining custom actions, ViewSets help streamline API development by reducing boilerplate code and promoting code reusability. By leveraging ViewSets, you can efficiently build and maintain RESTful APIs in Django, enhancing productivity and scalability in your projects.

Table of Contents