Django 2.2 和 Rest Framework 3.11 - 使用所有者的用户名字符串而不是 pk 部分更新模型“所有者”字段（外键）

Question

Django 2.2 和 Rest Framework 3.11

我有一个警报模型。 每个警报实例都可以选择拥有一个所有者（标准 django 用户模型）。

我希望能够通过仅使用他/她的用户名（字符串）而不是 pk 设置其所有者来部分更新（PATCH）警报。

现在，我只能通过使用他/她的 pk 来更新警报的所有者。

我尝试了各种方法，例如：

• 覆盖 AlarmSerializer 类中的 update() 方法，但是每当我在 PATCH 调用中使用所有者的用户名字符串而不是 pk 时，我都会返回：

{
    "owner": [
        "Incorrect type. Expected pk value, received str."
    ]
}

• 使用嵌套序列化程序和 lookup_field 但到目前为止还没有运气。

api 调用 (PATCH) 应如下所示：

url: /api/alarms/{alarm_id}/

有效载荷：

{
"owner": "owner_username"
}

我怎样才能做到这一点？ 谢谢

模型.py

from django.db import models
from django.conf import settings

class Alarm(models.Model):
"""
this class is meant to represent a network alarm (a.k.a. event or ticket)
coming from some monitoring system (Zabbix, Nagios, etc.)
"""
customer = models.CharField(max_length=50)
owner = models.ForeignKey(
    settings.AUTH_USER_MODEL,
    models.SET_NULL,
    blank=True,
    null=True,
)
managed = models.BooleanField(default=False, blank=False, verbose_name="Managed ?")
device_type = models.CharField(max_length=150)
...

序列化程序.py

from django.contrib.auth.models import User
from rest_framework import serializers
from .models import Alarm

class AlarmSerializer(serializers.ModelSerializer):

    class Meta:
        model = Alarm
        fields = [
                "customer",
                "owner",
                "device_type",
                "device_name",
                "ip_address",
                "date",
                ]

视图.py

from rest_framework import viewsets

from .models import Alarm
from .serializers import AlarmSerializer

# Create your views here.

class AlarmViewSet(viewsets.ModelViewSet):
    queryset = Alarm.objects.all()
    serializer_class = AlarmSerializer

Answer 1

我找到了一个解决方案：在 ModelViewSet 中转换 pk 中的所有者用户名字符串。

您需要在 views.py 中的 ModelViewSet 中覆盖 partial_update() 方法。

这个视图在序列化验证开始之前被 api PATCH 调用命中； 因此，这是将用户名字符串与用户名 pk 交换的正确位置。

视图.py

from django.contrib.auth.models import User
from django.shortcuts import get_object_or_404
from rest_framework import viewsets
from rest_framework.response import Response

from .models import Alarm
from .serializers import AlarmSerializer


class AlarmViewSet(viewsets.ModelViewSet):
    queryset = Alarm.objects.all()
    serializer_class = AlarmSerializer
    
    def partial_update(self, request, *args, **kwargs):
        instance = self.get_object()
        
        # if the owner field is not a string, it should be
        # a legit pk, so we don't do anything.
        if isinstance(request.data["owner"], str):
            owner_username = request.data.pop("owner")
            owner = get_object_or_404(User, username=owner_username)
            request.data["owner"] = owner.pk

        serializer = self.serializer_class(instance, data=request.data, partial=True)
        serializer.is_valid(raise_exception=True)
        serializer.save()

        return Response(serializer.data)