Django REST框架对象数组

问题描述 投票:14回答:4

我正在将Django REST framework用于API和带有Restangular的Angular SPA与API进行通信。有时,我必须使用API​​添加多个对象,我想可以将它们一起发送到一个数组中,并在一个请求中执行此操作。

我尝试从REST框架Web界面添加多个对象时收到wrong input错误。我正在传递对象或对象数组,如下所示:

// this { "text": "gdhg", },{ "text": "gdhg", },{ "text": "gdhg", }
// or this [{ "text": "gdhg", },{ "text": "gdhg", },{ "text": "gdhg", }]

但是我收到ParseError。我在哪里做错了,我必须更改以解决此问题?

django django-rest-framework restangular
4个回答
15
投票

另一个支持发布数组以及发布单个对象的示例。对于寻找此类示例的其他人可能很有用。

class BookViewSet(mixins.CreateModelMixin, mixins.ListModelMixin, viewsets.GenericViewSet):
    """
    ViewSet create and list books

    Usage single : POST
    {
        "name":"Killing Floor: A Jack Reacher Novel", 
        "author":"Lee Child"
    }

    Usage array : POST
    [{  
        "name":"Mr. Mercedes: A Novel (The Bill Hodges Trilogy)",
        "author":"Stephen King"
    },{
        "name":"Killing Floor: A Jack Reacher Novel", 
        "author":"Lee Child"
    }]
    """
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    search_fields = ('name','author')

    def create(self, request, *args, **kwargs):
        """
        #checks if post request data is an array initializes serializer with many=True
        else executes default CreateModelMixin.create function 
        """
        is_many = isinstance(request.data, list)
        if not is_many:
            return super(BookViewSet, self).create(request, *args, **kwargs)
        else:
            serializer = self.get_serializer(data=request.data, many=True)
            serializer.is_valid(raise_exception=True)
            self.perform_create(serializer)
            headers = self.get_success_headers(serializer.data)
            return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)

6
投票

我不确定问题是否仍然存在。但是fiver建议的解决方案对我不起作用。对我有用的是仅重写get_serializer方法。

def get_serializer(self, instance=None, data=None,
                    files=None, many=True, partial=False):
    return super(ViewName, self).get_serializer(instance, data, files,
                                                    many, partial)

如果您会注意到我在many=True的参数中设置了默认的get_serializer。除此之外,不需要任何操作。也不需要覆盖create方法。

此外,如果要在视图中定义pre_save和post_save方法,则期望列表(可迭代)作为方法的参数(在发布列表时),而不仅仅是单个对象。

def post_save(self, objects, *args, **kwargs):
    """
    In the post_save, list of obj has been created
    """
    for obj in objects:
        do_something_with(obj)

4
投票

这是使用Django REST框架在ListCreateAPIView中设置批量POST的示例:

class SomethingList(generics.ListCreateAPIView):
    model = Something
    serializer_class = SomethingSerializer

    def create(self, request, *args, **kwargs):
        serializer = self.get_serializer(data=request.DATA, many=True)
        if serializer.is_valid():
            serializer.save()
            headers = self.get_success_headers(serializer.data)
            return Response(serializer.data, status=status.HTTP_201_CREATED,
                            headers=headers)

        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

这里的重要部分是many=True方法的get_serializer()参数。然后,为了使Angular更好玩,您可以将服务工厂定义为:

.factory('Something', ['$resource', function ($resource) {
    return $resource(
        "url_to_something",
        {},
        {
            save: {
                method: 'POST',
                isArray: true
            }
        }
    );
}])

重要的部分是isArray: true。如果要保留发布单个JSON对象,可以将上面的save更改为saveBulk或类似内容。


1
投票

基于vibhor's answer

class ListableViewMixin(object):
    def get_serializer(self, instance=None, data=None, many=False, *args, **kwargs):
        return super(ListableViewMixin, self).get_serializer(
            instance=instance, data=data, many=isinstance(instance, list) or isinstance(data, list),
            *args, **kwargs)

使您的视图继承自这个mixin类,以自动确定是否应使用many=True序列化器。

© www.soinside.com 2019 - 2024. All rights reserved.