如何在 django rest 框架中通过其他字段而不是主键发布外键

Question

我正在开发一个宠物管理 API，这是我在为宠物分配一周中的某一天时发布到正文的内容：

{
   "day": "Sunday",
   "pet_name": 2 <-- how to add pet name (rather than the primary key)(this is a foreign key)
}

如何传入外键字段而不是主键字段的宠物名。

Answer 1

为避免混淆，我将 Day 的 pet_name 属性重命名为 pet，因为它引用了 Pet 模型。

class Day(models.Model):
    pet = models.ForeignKey(Pet, on_delete=models.CASCADE, null=True)

在您的DaySerializer 中，您只需使用SlugRelatedField 即可使用宠物的name 来引用宠物。

class DaySerializer(serializers.ModelSerializer):
    pet_props = PropsSerializer(read_only=True, many=True)
    pet = serializers.SlugRelatedField(slug_field='name')

    class Meta:
        model = models.Day
        fields = ("id", "day", "pet", "pet_props")

此序列化程序的表示会将宠物的name 作为pet 字段的值。同样在写作时，这允许您使用宠物的name 来引用pet 实例，这解决了您问题中的实际问题。

（从技术上讲，您也可以使用pet_name = serializers.SlugRelatedField(slug_field='name')，但我不会这样做以避免混淆。）

不过，我建议您对宠物的 name 属性设置一个唯一约束。

Answer 2

如果只想显示一些只读数据，可以使用SerializerMethodField：

from django.core.exceptions import ObjectDoesNotExist

class DaySerializer(serializers.ModelSerializer):
    pet_name = serializers.SerializerMethodField()

    def get_pet_name(self, obj):
        try:
            return obj.pet_name.name
        except ObjectDoesNotExist:
            # the day object doesn't have any
            # pet associated, so return None
            return None

---

注意：最好将 pet_name 外键更改为 pet，因为它包含一个 Pet 实例，而不仅仅是它的名称。