How do I use viewsets in Django REST framework?

How do I use viewsets in Django REST framework?

Viewsets in Django REST framework allow you to define the behavior of your API endpoints in a more concise way. You can create a viewset by subclassing one of the provided viewset classes, like ModelViewSet, which automatically provides CRUD operations.

Can you show me a simple example of a viewset?

Sure! Here's a basic example:

from rest_framework import viewsets
from .models import MyModel
from .serializers import MyModelSerializer

class MyModelViewSet(viewsets.ModelViewSet):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer

This viewset will handle GET, POST, PUT, and DELETE requests for MyModel.

How do I connect this viewset to a URL?

You can connect the viewset to a URL by using a router. Here's how:

from rest_framework.routers import DefaultRouter
from .views import MyModelViewSet

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

urlpatterns = router.urls

This will create the necessary routes for your viewset.

What if I want to add custom actions to my viewset?

You can add custom actions using the @action decorator. For example:

from rest_framework.decorators import action

class MyModelViewSet(viewsets.ModelViewSet):
    # ... existing code ...

    @action(detail=True, methods=['post'])
    def custom_action(self, request, pk=None):
        # Your custom logic here
        pass

This will create a new endpoint for the custom action.