用于更新对象字段的 API 调用

Question

所以我有一个模型序列化器，它包含

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ('id', 'name', 'description')

这是我的视图集

class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer

这是我的 URLs.py 文件：

from django.conf.urls import include, url
from rest_framework import routers
import views

router = DefaultRouter()
router.register('user', views.UserViewSet)
urlpatterns = [
    url(r'^', include(router.urls)),
    url(r'^login/', include('rest_framework.urls', namespace='rest_framework'))
]

使用序列化程序，我可以让它打印出我数据库中的对象。如果我有对象 PK/ID，我希望能够更新对象的字段 id 或 name。有没有办法使用序列化程序通过补丁/发布请求来做到这一点？我是新手，所以如果有人可以帮助我解决这个问题，我会很高兴。

我正在考虑只做一个POST 请求，然后让它这样做：

user = User.objects.get(id=id)
user.name = "XXXXX"
user.save()

但我想使用序列化程序执行此操作，使用 PATCH 请求。

Answer 1

由于您使用的是ModelViewset，因此应该内置此功能。如果您使用可浏览的API 导航到/user/<pk>/，您将看到可以对该对象执行的操作。默认情况下，ModelViewset 提供list()、retrieve()、create()、update() 和destroy() 功能。

http://www.django-rest-framework.org/api-guide/viewsets/#modelviewset

您也可以覆盖任何或所有提供的方法，但是单个对象的更新内置于 DRF 模型视图集。使用 curl 尝试对/user/<pk>/ 使用您想要更新的信息的 PATCH。

Answer 2

Django rest 框架自带一些预定义的concrete generic views 如UpdateAPIView、RetrieveUpdateAPIView。

首先，您需要为user 创建一个视图，该视图使用可以update 的视图之一。更新视图为视图上的patch 方法提供处理程序。

RetrieveUpdateAPIView

用于读取或更新端点以表示单个模型实例。

提供get、put 和patch 方法处理程序。

现在，用它来创建一个视图：

class UserDetail(generics.RetrieveUpdateAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer

要访问此视图，您需要有一个使用用户主键访问用户的 url：

url(r'users/(?P<pk>\d+)/$', UserDetail.as_view(), name='api-user-detail'),

然后使用 PATCH 调用可以更新用户的name。

Answer 3

下面的代码会对你有所帮助，

**filename : views.py**

from user.models import User
from users.serializers import UserSerializer
from django.http import Http404
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status


class UserList(APIView):
    """
    List all users, or create a new user.
    """
    def get(self, request, format=None):
        users = User.objects.all()
        serializer = UserSerializer(users, many=True)
        return Response(serializer.data)

    def post(self, request, format=None):
        serializer = UserSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

class UserDetail(APIView):
    """
    Retrieve, update or delete a user instance.
    """
    def get_object(self, pk):
        try:
            return User.objects.get(pk=pk)
        except User.DoesNotExist:
            raise Http404

    def get(self, request, pk, format=None):
        user = self.get_object(pk)
        serializer = UserSerializer(user)
        return Response(serializer.data)

    def put(self, request, pk, format=None):
        user = self.get_object(pk)
        serializer = UserSerializer(user, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

    def delete(self, request, pk, format=None):
        user = self.get_object(pk)
        user.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)


**filename : urls.py**

from django.conf.urls import url
from rest_framework.urlpatterns import format_suffix_patterns
from users import views

urlpatterns = [
    url(r'^users/$', views.UserList.as_view()),
    url(r'^user/(?P<pk>[0-9]+)/$', views.UserDetail.as_view()),
]

urlpatterns = format_suffix_patterns(urlpatterns)

参考：http://www.django-rest-framework.org/tutorial/3-class-based-views/