在序列器中输出OneToOne关系的查找字段。

Question

我想在我的API字段中输出来自两个不同（相关）的模型。

我有这个models.py。

class User(AbstractBaseUser):
    first_name = models.CharField(max_length=30, blank=True, null=True)
    surname = models.CharField(max_length=30, blank=True, null=True)

    def __str__(self):
        return "%s %s" % (self.first_name, self.surname) # I don't want to change this.

class Profile(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE, related_name='profile', null=True, blank=True)
    first_nameUnregistered = models.CharField(max_length=120, null=True, blank=True)
    surnameUnregistered = models.CharField(max_length=120, null=True, blank=True)

这是我的序列器:

class ProfileSerialiser(serializers.HyperlinkedModelSerializer):

    user = serializers.StringRelatedField(many=False)

    class Meta:
        model = Profile
        fields = ('first_nameUnregistered', 'surnameUnregistered', 'user')

还有我的视图

class ProfileViewSet(viewsets.ModelViewSet):
    queryset = Profile.objects.all()
    serializer_class = ProfileSerialiser

现在，当我进入我的apiprofliles端点时，我看到的是：

[
    {
        "first_nameUnregistered": "",
        "surnameUnregistered": "",
        "user": "The full user name, coming from def __str__(self):"
    },
[...]

我想得到这样的东西：

[
    {
        "first_nameUnregistered": "",
        "surnameUnregistered": "",
        "user.first_name": "first name"
        "user.surnamee": "surname"
    },
[...]

查找，如 profile__user.first_name 似乎无法工作，我无法合并两个查询集，因为它们来自不同的模型，而且我无法使用在 fields 序化器的定义。如何才能达到我想要的目的？

解决办法

感谢@Jan Giacomelli给我指出了这个问题。source 关键字。我必须添加一个默认值，因为如果一个字段是空的，Django Rest Framework会抛出一个错误。

Got AttributeError when attempting to get a value for field `user__first_name` on serializer `ProfileSerialiser`.
The serializer field might be named incorrectly and not match any attribute or key on the `Profile` instance.
Original exception text was: 'NoneType' object has no attribute 'first_name'.

因此，我的完整工作代码是：

class ProfileSerialiser(serializers.HyperlinkedModelSerializer):

    user__first_name = serializers.CharField(source='user.first_name', default='name')
    user__surname = serializers.CharField(source='user.surname', default='name')

    class Meta:
        model = Profile
        fields = ('id', 'first_nameUnregistered', 'surnameUnregistered', 'user__first_name', 'user__surname')

Answer 1

你可以使用 源头 字段选项中的关键字参数。这样你就可以访问相关对象的属性。

将你的序列器改为。

class ProfileSerialiser(serializers.HyperlinkedModelSerializer):

    user__first_name = serializers.CharField(source='user.first_name')
    user__surname = serializers.CharField(source='user.last_name')

    class Meta:
        model = Profile
        fields = ('first_nameUnregistered', 'surnameUnregistered', 'user__first_name', 'user__surname')

它将返回这样的输出。

[
    {
        "first_nameUnregistered": "",
        "surnameUnregistered": "",
        "user__first_name": "first name"
        "user__surname": "surname"
    },
[...]