Disable a method in a ViewSet, django-rest-framework

python

viewsets

django-rest-framework

http-method-names

byNikita Barsukov·Feb 5, 2025

Instantly disable any method like POST inside a Django REST Framework ViewSet by overriding and raising a MethodNotAllowed exception:

from rest_framework.exceptions import MethodNotAllowed

class MyViewSet(viewsets.ModelViewSet):
    # ...

    def create(self, request, *args, **kwargs):
        # Sorry POST, not today!
        raise MethodNotAllowed('POST')

For conditional disabling or peculiar methods, adjust with the @action decorator:

from rest_framework.decorators import action

class MyViewSet(viewsets.ModelViewSet):
    # ...

    @action(methods=['get'], detail=False)
    def custom_method(self, request):
        # GET your act together!

methods=['get'] restricts to only GET requests.

Unleashing http_method_names

Not a fan of overriding each method individually? Use http_method_names and call the shots on your allowed methods:

class MyViewSet(viewsets.ViewSet):
    # Define allowed HTTP methods
    http_method_names = ['get', 'head', 'options']

    # POST me not, PUT me not, DELETE me definitely not!

This little trick even excuses unsupported actions from the Browsable API. Now that's multitasking!

Define your operations with custom mixins

With custom mixins, you can whip up a combination of operations without the extra baggage of ModelViewSet:

from rest_framework import mixins
from rest_framework import viewsets

# Selective operations like a boss!
class CustomViewSet(mixins.CreateModelMixin, mixins.ListModelMixin, viewsets.GenericViewSet):
    # Your impressive view set code here

Now, you can balance your CRUD operations like a pro and stay light on your feet!

Custom routers for precise control

Building a custom router helps you mark specific methods as no-go zones in your URL conf, ensuring they don't crash your party unwelcome:

from rest_framework.routers import SimpleRouter

class CustomRouter(SimpleRouter):
    def get_method_map(self, viewset, method_map):
        # Excuse me, DELETE, this way please
        method_map = super().get_method_map(viewset, method_map)
        method_map.pop('delete', None)
        return method_map

This way, you guarantee that your API schema precisely mirrors the abilities your API is proud of.

Benefit gracefully from DRF 3.14.0

Don't forget to upgrade to DRF 3.14.0 for classy handling of HTTP 405 Method Not Allowed errors. Say goodbye to any disabled method in your OPTIONS request, making the powers of your API absolutely clear:

# Behold! Improved 405 management in DRF 3.14.0

This is as good as a friendly nudge to keep your Django REST Framework upgraded for security patches and an alluring array of new, fancy features.

explain-codes / Python / Disable a method in a ViewSet, django-rest-framework

Linked

How to make CREATE OR REPLACE VIEW work in SQL Server?



Separation of business logic and data access in django



What is Dispatcher Servlet in Spring?



Trigger 404 in Spring-MVC controller?



How do you create a REST client for Java?



How to combine multiple QuerySets in Django?



Why is iterating through a large Django QuerySet consuming massive amounts of memory?



Unleashing http_method_names Define your operations with custom mixins Custom routers for precise control Benefit gracefully from DRF 3.14.0