Django Rest Framework使用PrimaryKeyRelatedField返回嵌套对象

Question

我正在使用DRF来公开一些API端点.

# models.py

class Project(models.Model):
    ...
    assigned_to = models.ManyToManyField(
        User, default=None, blank=True, null=True
    )



# serializers.py

class ProjectSerializer(serializers.ModelSerializer):
    assigned_to = serializers.PrimaryKeyRelatedField(
        queryset=User.objects.all(), required=False, many=True)

    class Meta:
        model = Project
        fields = ('id', 'title', 'created_by', 'assigned_to')


# view.py

class ProjectList(generics.ListCreateAPIView):
    mode   = Project
    serializer_class = ProjectSerializer
    filter_fields = ('title',)

    def post(self, request, format=None):
        # get a list of user.id of assigned_to users
        assigned_to = [x.get('id') for x in request.DATA.get('assigned_to')]
        # create a new project serilaizer
        serializer = ProjectSerializer(data={
            "title": request.DATA.get('title'),
            "created_by": request.user.pk,
            "assigned_to": assigned_to,
        })
        if serializer.is_valid():
            serializer.save()
        else:
            return Response(serializer.errors,
                        status=status.HTTP_400_BAD_REQUEST)
        return Response(serializer.data, status=status.HTTP_201_CREATED)

这一切都很好,我可以POST分配给字段的id列表.但是,为了实现这个功能,我必须使用PrimaryKeyRelatedField而不是RelatedField.这意味着当我这样做时,我GET只收到该assigned_to字段中用户的主键.有没有办法维护当前行为POST但返回User该assigned_to字段的序列化详细信息？

Answer 1

我最近用一个子类解决了这个问题，PrimaryKeyRelatedField()它使用 id 作为输入来设置值，但使用序列化程序返回一个嵌套值。现在这可能不是这里要求的 100%。POST、PUT 和 PATCH 响应也将包括嵌套表示，而问题确实指定 POST 的行为与它对 PrimaryKeyRelatedField 的行为完全相同。

https://gist.github.com/jmichalicek/f841110a9aa6dbb6f781

class PrimaryKeyInObjectOutRelatedField(PrimaryKeyRelatedField):
    """
    Django Rest Framework RelatedField which takes the primary key as input to allow setting relations,
    but takes an optional `output_serializer_class` parameter, which if specified, will be used to
    serialize the data in responses.

    Usage:
        class MyModelSerializer(serializers.ModelSerializer):
            related_model = PrimaryKeyInObjectOutRelatedField(
                queryset=MyOtherModel.objects.all(), output_serializer_class=MyOtherModelSerializer)

            class Meta:
                model = MyModel
                fields = ('related_model', 'id', 'foo', 'bar')

    """

    def __init__(self, **kwargs):
        self._output_serializer_class = kwargs.pop('output_serializer_class', None)
        super(PrimaryKeyInObjectOutRelatedField, self).__init__(**kwargs)

    def use_pk_only_optimization(self):
        return not bool(self._output_serializer_class)

    def to_representation(self, obj):
        if self._output_serializer_class:
            data = self._output_serializer_class(obj).data
        else:
            data = super(PrimaryKeyInObjectOutRelatedField, self).to_representation(obj)
        return data

Answer 2

你需要使用不同的串行的POST，并GET在这种情况下。

查看覆盖get_serializer_class()视图上的方法，并根据self.request.method.