如何将json数据发布/放入ListSerializer

时间:2015-01-09 21:51:11

标签: python django django-rest-framework

我正在阅读有关自定义多个更新here 的内容,我还没想到在什么情况下会调用自定义ListSerializer更新方法。我想一次更新多个对象,我现在不担心多次创建或删除。

来自文档中的示例:

# serializers.py
class BookListSerializer(serializers.ListSerializer):
    def update(self, instance, validated_data):
        # custom update logic
        ...

class BookSerializer(serializers.Serializer):
    ...
    class Meta:
        list_serializer_class = BookListSerializer

我的ViewSet

# api.py
class BookViewSet(ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

我的网址设置使用DefaultRouter

# urls.py
router = routers.DefaultRouter()
router.register(r'Book', BookViewSet)

urlpatterns = patterns('',                       
    url(r'^api/', include(router.urls)),
    ...

所以我使用DefaultRouter进行了此设置,以便/api/Book/将使用BookSerializer

一般的想法是,如果我将一个JSON对象的POST / PUT / PATCH发送到/api/Book/,那么序列化器应切换到BookListSerializer

我已经尝试了POST {PUT / PATCH JSON数据列表到这个/api/Book/,如下所示:

[ {id:1,title:thing1}, {id:2, title:thing2} ]

但似乎仍然使用BookSerializer代替BookListSerializer来处理数据。如果我通过POST提交,我会收到Invalid data. Expected a dictionary, but got list。如果我通过PATCH或PUT提交,那么我会收到Method 'PATCH' not allowed错误。

问题: 我是否必须调整allowed_methodsDefaultRouter的{​​{1}}以允许列表的POST / PATCH / PUT?通用视图是否未设置为与BookViewSet一起使用?

我知道我可以为此编写自己的列表反序列化程序,但我正在努力了解DRF 3中的新功能,看起来这应该可行但我只是缺少一些约定或某些选项

1 个答案:

答案 0 :(得分:37)

Django REST框架默认假设您不处理批量数据创建,更新或删除。这是因为99%的人没有处理批量数据创建,DRF leaves the other 1% to third-party libraries

在Django REST框架2.x和3.x中,第三方包exists for this

现在,您正在尝试进行批量创建,但是您收到的错误是

  

无效数据。期待一本字典,但得到了列表

这是因为您要发送要创建的对象列表,而不是仅发送一个。您可以通过以下几种方式解决这个问题,但最简单的方法是在序列化列表为override get_serializer on your view时{}为add the many=True flag

def get_serializer(self, *args, **kwargs):
    if "data" in kwargs:
        data = kwargs["data"]

        if isinstance(data, list):
            kwargs["many"] = True

    return super(MyViewSet, self).get_serializer(*args, **kwargs)

这将允许Django REST框架知道在批量创建对象时自动使用ListSerializer。现在,对于其他操作(如更新和删除),您将需要覆盖默认路由。我假设您正在使用routes provided by Django REST framework bulk,但您可以自由使用您想要的任何方法名称。

您还需要将批量PUTPATCH的方法添加到视图中。

from rest_framework.response import Response

def bulk_update(self, request, *args, **kwargs):
    partial = kwargs.pop("partial", False)

    queryset = self.filter_queryset(self.get_queryset))

    serializer = self.get_serializer(instance=queryset, data=request.data, many=True)
    serializer.is_valid(raise_exception=True)

    self.perform_update(serializer)

    return Response(serializer.data)

def partial_bulk_update(self, *args, **kwargs):
    kargs["partial"] = True
    return super(MyView, self).bulk_update(*args, **kwargs)

由于Django REST框架默认不支持批量更新,因此无法开箱即用。这意味着你也have to implement your own bulk updates。当前代码将处理批量更新,就像您尝试更新整个列表一样,这是旧批量更新包以前的工作方式。

虽然您没有要求批量删除,但这并不是特别困难。

def bulk_delete(self, request, *args, **kwargs):
    queryset = self.filter_queryset(self.get_queryset())
    self.perform_delete(queryset)
    return Response(status=204)

这与删除所有对象具有相同的效果,与旧的批量插件相同。

此代码均未经过测试。如果它不起作用,请将其视为一个详细示例。