Django REST Framework PATCH 请求使用查询而不是 ID 或 PK

Question

我有一个 Building 模型，为此我创建了一个序列化程序和 ModelViewSet。

我可以通过发送 PATCH 请求并指定 模型 ID 来更新模型，如下所示：

curl http://127.0.0.1/dashboard/api/v1/buildings/3/ \
--request PATCH \
--header "Content-Type: application/json" \
--data '{"name": "School","address": "123 Some Street","description": "A place to learn"}'

如何通过查询字段而不是传递模型 ID 来更新建筑模型？例如：

curl http://127.0.0.1/dashboard/api/v1/buildings/?name=hospital \
--request PATCH \
--header "Content-Type: application/json" \
--data '{"name": "School","address": "123 Some Street","description": "A place to learn"}'

注意，建筑物名称是唯一的！

此功能非常有用，因为客户端通常不知道模型 ID，而是知道它希望更新的模型的属性。

---

views.py

class APIBuildingsViewSet(viewsets.ModelViewSet):
    queryset = Building.objects.all()
    serializer_class = BuildingSerializer
    filter_backends = [DjangoFilterBackend]
    filterset_fields = ['name', 'address']

models.py

class Building(models.Model):
    building_id = models.AutoField('ID', auto_created=True, primary_key=True)
    name        = models.CharField('Name', max_length=125, null=True, blank=False, unique=True)
    address     = models.CharField('Address', max_length=256, null=False, blank=False)
    user_id     = models.ForeignKey('accounts.User', on_delete=models.CASCADE, default=1)

    def __str__(self):
        return self.name

serializers.py

class BuildingSerializer(serializers.ModelSerializer):
    class Meta:
        model = Building
        fields = ('building_id', 'name', 'address', 'user_id')

urls.py

router = DefaultRouter()
router.register(r'buildings', views.APIBuildingsViewSet, base_name='buildings')

urlpatterns = [
    url(r'^api/', include(router.urls)),
]

Answer 1

您可以在您的ModelViewSet 中设置您的lookup_field to be name：

class APIBuildingsViewSet(viewsets.ModelViewSet):
    queryset = Building.objects.all()
    serializer_class = BuildingSerializer
    filter_backends = [DjangoFilterBackend]
    filterset_fields = ['name', 'address']
    lookup_field = 'name'

然后您可以使用建筑物name：/api/v1/buildings/hospital/访问详细路线