Django REST API accept list instead of dictionary in post request

Question

I am trying to consume data from a callback API that sends the POST request in this format:

[
  {
    "key1": "asd",
    "key2": "123"
  }
]

However my API currently only works when it is sent like this:

{
  "key1": "asd",
  "key2": "123"
}

serializers.py:

class RawIncomingDataSerializer(serializers.ModelSerializer):
    class Meta:
        model = RawIncomingData
        fields = '__all__'

views.py:

class RawIncomingDataViewSet(viewsets.ModelViewSet):
    queryset = RawIncomingData.objects.all()
    serializer_class = RawIncomingDataSerializer

There will only ever be one object in the post data, so I am looking for a simple work around without having to rewrite my serializer to interpret multiple objects in one post request.

score 6 · Accepted Answer · answered Oct 29 '21 at 03:41

In that case you can override create and explicitly specify many=True in the get_serializer call:

class RawIncomingDataViewSet(viewsets.ModelViewSet):
    ...
    def create(self, request, *args, **kwargs):
        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)

JPG · Answer 2 · 2021-10-29T10:30:26.413

2

The idea is to pass many=True into the serializer class. So, I would choose to override the get_serializer(...) method, as

class RawIncomingDataViewSet(viewsets.ModelViewSet):
    queryset = RawIncomingData.objects.all()
    serializer_class = RawIncomingDataSerializer

    def get_serializer(self, *args, **kwargs):
        if self.action == "create":
            kwargs["many"] = True
        return super().get_serializer(*args, **kwargs)

edited Oct 29 '21 at 10:30

answered Oct 29 '21 at 04:17

JPG

82,442
19
127
206

3

I was inclining on doing this as well originally but since model viewset was used, this will affect `update` and `retrieve` right? In this case, with this approach there would be a need to also check whether the action was `create` or the method was `post` before using `many=True` – Brian Destura Oct 29 '21 at 05:08

Django REST API accept list instead of dictionary in post request

2 Answers2