Django REST 框架：ViewSet 中不允许使用 def update() 方法 PUT

Question

在 DRF 中，我有一个像这样的简单 ViewSet：

class MyViewSet(viewsets.ViewSet):       

    def update(self, request):
        # do things...
        return Response(status=status.HTTP_200_OK)

当我尝试 PUT 请求时，我收到一个错误，例如不允许 PUT 方法。如果我使用 def put(self, request): 一切正常。根据the docs我应该使用def update():而不是def put():，为什么会这样？

Answer 1

这是因为APIView 没有为.put() 方法定义处理程序，因此传入的请求无法映射到视图上的处理程序方法，从而引发异常。

（注：viewsets.ViewSet 继承自 ViewSetMixin 和 APIView）

APIView 中的dispatch() 方法检查是否为请求method 定义了方法处理程序。如果dispatch() 方法找到请求方法的处理程序，它会返回适当的响应。否则，它会引发异常MethodNotAllowed。

根据APIView类中dispatch()方法的源码：

def dispatch(self, request, *args, **kwargs):       
        ...
        ...    
        try:
            self.initial(request, *args, **kwargs)

            # Get the appropriate handler method
            if request.method.lower() in self.http_method_names:
                 # here handler is fetched for the request method
                 # `http_method_not_allowed` handler is assigned if no handler was found
                handler = getattr(self, request.method.lower(),
                                  self.http_method_not_allowed)
            else:
                handler = self.http_method_not_allowed 

            response = handler(request, *args, **kwargs) # handler is called here

        except Exception as exc:
            response = self.handle_exception(exc)

        self.response = self.finalize_response(request, response, *args, **kwargs)
        return self.response

由于.put() 方法处理程序未在您的视图中定义，DRF 调用回退处理程序.http_method_not_allowed。这会引发 MethodNotAllowed 异常。

.http_method_not_allowed()的源码为：

def http_method_not_allowed(self, request, *args, **kwargs):
    """
    If `request.method` does not correspond to a handler method,
    determine what kind of exception to raise.
    """
    raise exceptions.MethodNotAllowed(request.method) # raise an exception 

为什么在您的视图中定义 .put() 时它会起作用？

当您在视图中定义def put(self, request): 时，DRF 可以将传入的请求方法映射到视图上的处理程序方法。这导致返回适当的响应而不会引发异常。

Answer 2

此代码存在类似的“不允许使用 Method PUT”问题，因为请求中缺少“id”：

class ProfileStep2Serializer(serializers.ModelSerializer):
    class Meta:
        model = Profile
        fields = ('middle_initial', 'mobile_phone', 'address', 'apt_unit_num', 'city', 'state', 'zip')

class Step2ViewSet(viewsets.ModelViewSet):
    serializer_class = ProfileStep2Serializer

    def get_queryset(self):
        return Profile.objects.filter(pk=self.request.user.profile.id)

原来我在序列化器字段中遗漏了“id”，因此 PUT 请求无法为记录提供 id。序列化器的固定版本如下：

class ProfileStep2Serializer(serializers.ModelSerializer):
    class Meta:
        model = Profile
        fields = ('id', 'middle_initial', 'mobile_phone', 'address', 'apt_unit_num', 'city', 'state', 'zip')

Answer 3

PUT 默认需要 id 在 URL 中

有时POST和PUT是有区别的，因为PUT在URL中需要id 这就是您收到错误消息的原因：“PUT is not Allowed”。

例子：

• 发布：/api/users/
• 放置：/api/users/1/

希望它能为某人节省很多时间

Answer 4

这个答案是对的，Django REST framework: method PUT not allowed in ViewSet with def update()，PUT 是不允许的，因为 DRF 期望实例 id 在 URL 中。话虽如此，在你的 ViewSet 中使用这个 mixin 可能是修复它的最好方法（来自https://gist.github.com/tomchristie/a2ace4577eff2c603b1b 复制粘贴在下面）

class AllowPUTAsCreateMixin(object):
    """
    The following mixin class may be used in order to support PUT-as-create
    behavior for incoming requests.
    """
    def update(self, request, *args, **kwargs):
        partial = kwargs.pop('partial', False)
        instance = self.get_object_or_none()
        serializer = self.get_serializer(instance, data=request.data, partial=partial)
        serializer.is_valid(raise_exception=True)

        if instance is None:
            lookup_url_kwarg = self.lookup_url_kwarg or self.lookup_field
            lookup_value = self.kwargs[lookup_url_kwarg]
            extra_kwargs = {self.lookup_field: lookup_value}
            serializer.save(**extra_kwargs)
            return Response(serializer.data, status=status.HTTP_201_CREATED)

        serializer.save()
        return Response(serializer.data)

    def partial_update(self, request, *args, **kwargs):
        kwargs['partial'] = True
        return self.update(request, *args, **kwargs)

    def get_object_or_none(self):
        try:
            return self.get_object()
        except Http404:
            if self.request.method == 'PUT':
                # For PUT-as-create operation, we need to ensure that we have
                # relevant permissions, as if this was a POST request.  This
                # will either raise a PermissionDenied exception, or simply
                # return None.
                self.check_permissions(clone_request(self.request, 'POST'))
            else:
                # PATCH requests where the object does not exist should still
                # return a 404 response.
                raise

Answer 5

def update(self, request, pk=None):
    data_in = request.data
    print(data_in)

    instance = self.get_object()
    serializer = self.get_serializer(instance, data=request.data, partial=False)
    serializer.is_valid(raise_exception=True)

    if instance is None:
        lookup_url_kwarg = self.lookup_url_kwarg or self.lookup_field
        lookup_value = self.kwargs[lookup_url_kwarg]
        extra_kwargs = {self.lookup_field: lookup_value}
        serializer.save(**extra_kwargs)
        return Response(serializer.data, status=status.HTTP_201_CREATED)
    serializer.save()
    data_out = serializer.data
    return Response(serializer.data)

Answer 6

使用 Django 视图集，您可以轻松地在 url 中映射方法，例如

path('createtoken/', CreateTokenView.as_view({'post': 'create', 'put':'update'}))

然后在您的班级中随意覆盖方法：

class CreateTokenView(viewsets.ModelViewSet):
    queryset = yourSet.objects.all()
    serializer_class = yourSerializer

    def create(self, request, *args, **kwargs):
        #any method you want here
        return Response("response")

    def update(self, request, *args, **kwargs):
        # any method you want here
        return Response("response")

Answer 7

我有多个使用 ModelViewSet 的对象，并且都有不同的（唯一）字段用于查找。

因此，我通过在父类上定义 put 和可用于将有效负载与现有对象关联的新字段 lookup_body_field 来为这个问题提出另一个解决方案：

class CustomViewSet(viewsets.ModelViewSet):
    lookup_body_field = 'id'

    def put(self, pk=None):
        lookup_value = self.request.data.get(self.lookup_body_field)
        if not lookup_value:
            raise ValidationError({self.lookup_body_field: "This field is mandatory"})

        obj = self.get_queryset().filter(**{self.lookup_body_field: lookup_value}).last()
        if not obj:
            return self.create(request=self.request)
        else:
            self.kwargs['pk'] = obj.pk
            return self.update(request=self.request)


class MyViewSetA(CustomViewSet)
    model = ModelA
    lookup_body_field = 'field_a'  # Unique field on ModelA

class MyViewSetB(CustomViewSet)
    model = ModelB
    lookup_body_field = 'field_b'  # Unique field on ModelA


    

Answer 8

假设

你已经注册了这样的路由（在 urls.py 中）

router = DefaultRouter()
router.register(r'users', UserViewSet, basename='user-viewset')
urlpatterns += router.urls

而你的 restapi 溃败以 /api/ 开头。

ViewSets 生成跟随路线。

创建用户（在正文中发送用户对象）
POST
/api/users/

获取用户列表
GET
/api/users/

获取用户
获取
/api/users/{id}/

更新用户（完整对象更新）
PUT
/api/users/{id}/

用户的部分更新
PATCH
/api/users/{id}/

删除用户
删除
/api/users/{id}/