Вимкніть метод у ViewSet, django-rest-frame

ViewSets мати автоматичні методи для переліку, пошуку, створення, оновлення, видалення, ...

Я хотів би відключити деякі з них, і рішення, яке я придумав, мабуть, не є вдалим, оскільки OPTIONSвсе-таки заявляє, що це дозволено.

Будь-яка ідея, як це зробити правильно?

class SampleViewSet(viewsets.ModelViewSet):
    queryset = api_models.Sample.objects.all()
    serializer_class = api_serializers.SampleSerializer

    def list(self, request):
        return Response(status=status.HTTP_405_METHOD_NOT_ALLOWED)
    def create(self, request):
        return Response(status=status.HTTP_405_METHOD_NOT_ALLOWED)

Визначення ModelViewSet:

class ModelViewSet(mixins.CreateModelMixin, 
                   mixins.RetrieveModelMixin, 
                   mixins.UpdateModelMixin,
                   mixins.DestroyModelMixin,
                   mixins.ListModelMixin,
                   GenericViewSet)

Тож замість того, щоб продовжувати ModelViewSet, чому б просто не використовувати все, що потрібно? Так, наприклад:

from rest_framework import viewsets, mixins

class SampleViewSet(mixins.RetrieveModelMixin,
                    mixins.UpdateModelMixin,
                    mixins.DestroyModelMixin,
                    viewsets.GenericViewSet):
    ...

При такому підході маршрутизатор повинен генерувати маршрути лише для включених методів.

Довідка :

ModelViewSet

Ви можете продовжувати використовувати viewsets.ModelViewSetта визначати http_method_namesу своєму ViewSet.

Приклад

class SampleViewSet(viewsets.ModelViewSet):
    queryset = api_models.Sample.objects.all()
    serializer_class = api_serializers.SampleSerializer
    http_method_names = ['get', 'post', 'head']

Як тільки ви додасте http_method_names, ви більше не зможете це зробити putі patchбільше.

Якщо ви хочете, putале не хочете patch, можете триматиhttp_method_names = ['get', 'post', 'head', 'put']

Внутрішнє враження від DRF поширюється на CBD Django. Django CBV має атрибут під назвою http_method_names. Таким чином, ви можете використовувати http_method_names і для перегляду DRF.

[Безсоромний штекер]: Якщо ця відповідь була корисною, вам сподобається моя серія публікацій на DRF за адресою https://www.agiliq.com/blog/2019/04/drf-polls/ .

Хоча минув час на цій посаді, я раптом з’ясував, що насправді це спосіб відключити ці функції, ви можете редагувати її в views.py безпосередньо.

Джерело: https://www.django-rest-framework.org/api-guide/viewsets/#viewset-action

from rest_framework import viewsets, status
from rest_framework.response import Response

class NameWhateverYouWantViewSet(viewsets.ModelViewSet):

    def create(self, request):
        response = {'message': 'Create function is not offered in this path.'}
        return Response(response, status=status.HTTP_403_FORBIDDEN)

    def update(self, request, pk=None):
        response = {'message': 'Update function is not offered in this path.'}
        return Response(response, status=status.HTTP_403_FORBIDDEN)

    def partial_update(self, request, pk=None):
        response = {'message': 'Update function is not offered in this path.'}
        return Response(response, status=status.HTTP_403_FORBIDDEN)

    def destroy(self, request, pk=None):
        response = {'message': 'Delete function is not offered in this path.'}
        return Response(response, status=status.HTTP_403_FORBIDDEN)

Якщо ви намагаєтесь відключити метод PUT з набору перегляду DRF, ви можете створити власний маршрутизатор:

from rest_framework.routers import DefaultRouter

class NoPutRouter(DefaultRouter):
    """
    Router class that disables the PUT method.
    """
    def get_method_map(self, viewset, method_map):

        bound_methods = super().get_method_map(viewset, method_map)

        if 'put' in bound_methods.keys():
            del bound_methods['put']

        return bound_methods

Відключивши метод на маршрутизаторі, ваша документація схеми api буде правильною.

Як відключити метод "DELETE" для ViewSet в DRF

class YourViewSet(viewsets.ModelViewSet):
    def _allowed_methods(self):
        return [m for m in super(YourViewSet, self)._allowed_methods() if m not in ['DELETE']]

PS Це надійніше, ніж чітко вказати всі необхідні методи, тому менше шансів забути деякі важливі методи ВАРІАНТИ, ГОЛОВА тощо

PPS за замовчуванням має DRF http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

У Django Rest Framework 3.xx ви можете просто включити кожен метод, для якого потрібно включити ModelViewSet, передавши словник as_viewметоду. У цьому словнику ключ повинен містити тип запиту (GET, POST, DELETE тощо), а значення повинно містити відповідне ім'я методу (список, отримання, оновлення тощо). Наприклад, скажіть, що ви хочете Sampleстворити або прочитати модель, але ви не хочете, щоб її змінювали. Так це означає, що ви хочете list, retrieveі createметод потрібно включити (і ви хочете, щоб інші були відключені.)

Все, що вам потрібно зробити, - це додати шляхи до urlpatternsтаких:

path('sample/', SampleViewSet.as_view({
    'get': 'list',
    'post': 'create'
})),
path('sample/<pk>/', SampleViewSet.as_view({  # for get sample by id.
    'get': 'retrieve'
}))

Як ви можете бачити , немає ніякого deleteі putзапиту в налаштуваннях вище маршрутизації, наприклад , якщо ви відправляєте putзапит на URL - адреса, то відповідь ви з 405 Method Not Allowed:

{
    "detail": "Method \"PUT\" not allowed."
}

Якщо ви плануєте відключити методи put / post / знищити, ви можете використовувати

viewsets.ReadOnlyModelViewSet https://www.django-rest-framework.org/tutorial/6-viewsets-and-routers/#refactoring-to-use-viewsets