Django REST 框架外键和过滤

Question

我在 Django 应用中有以下模型：

模型.py ：

class Make(BaseModel):
    slug = models.CharField(max_length=32) #alfa-romeo
    name = models.CharField(max_length=32) #Alfa Romeo

    def __unicode__(self):
        return self.name

class Model(BaseModel):
    make = models.ForeignKey(Make)  #Alfa Romeo
    name = models.CharField(max_length=64) # line[2]
    engine_capacity = models.IntegerField()
    trim = models.CharField(max_length=128) # line[4]

和serializers.py ：

from .models import Make,Model
from rest_framework import serializers


class MakeSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Make
        fields = ('url', 'slug', 'name')


class ModelSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Model
        fields = ('url', 'make', 'name', 'trim', 'engine_capacity')

还有views.py ：

from rest_framework import viewsets
from rest_framework import filters
from rest_framework import generics

from .models import Make, Model
from .serializers import MakeSerializer, ModelSerializer


class MakeViewSet(viewsets.ModelViewSet):
    queryset = Make.objects.all()
    serializer_class = MakeSerializer
    filter_backends = (filters.DjangoFilterBackend,)

class ModelViewSet(viewsets.ModelViewSet):
    make = MakeSerializer
    queryset = Model.objects.all()
    serializer_class = ModelSerializer
    filter_backends = (filters.DjangoFilterBackend,)

我需要做什么，我想获取由特定品牌制造的所有模型。 如何使用查询参数获取具有特定 make 外键的所有模型？ 我的第二个问题 - 我可以使用 queryparams 过滤结果以获得具有特定引擎容量的模型吗？

一条评论：如果我可以在 url: /api/models/?make=ford中使用类似这样的内容查询结果，那就太完美了，其中make是Make模型中的slug字段

Answer 1

您可以在视图集中指定filter_fields = ('make__slug', ) 。 不要忘记包含filter_backends = (DjangoFilterBackend, ) 。 您还需要添加django-filter依赖项。

class ModelViewSet(viewsets.ModelViewSet):
    queryset = Model.objects.all()
    serializer_class = ModelSerializer
    filter_backends = (filters.DjangoFilterBackend,)
    filter_fields = ('make__slug',)

然后你像/api/models/?make__slug=ford这样的查询。 注意双下划线符号。

文档。

如果你不喜欢 URL 中的make__slug关键字参数，那么你可以创建一个过滤器类：

import django_filters

from myapp.models import Make


class ModelFilter(django_filters.FilterSet):
    make = django_filters.ModelChoiceFilter(field_name="make__slug",
                                            queryset=Make.objects.all())

    class Meta:
        model = Model
        fields = ('make',)

进而

class ModelViewSet(viewsets.ModelViewSet):
    make = MakeSerializer
    queryset = Model.objects.all()
    serializer_class = ModelSerializer
    filter_backends = (filters.DjangoFilterBackend,)
    filter_class = ModelFilter

/api/models/?make=ford应该可以工作。

Answer 2

网址.py

url('^model/by/(?P<make>\w+)/$', ModelByMakerList.as_view()),

视图.py

class ModelByMakerList(generics.ListAPIView):
    serializer_class = ModelSerializer

    def get_queryset(self):
        """
        This view should return a list of all models by
        the maker passed in the URL
        """
        maker = self.kwargs['make']
        return Model.objects.filter(make=maker)

有关更多信息，请查看文档。

您也可以使用 QUERY_PARAMS 过滤，但恕我直言，这看起来更好。

Answer 3

要扩展@vladimir-prudnikov 的回答：

在 django-filter 的最新版本中，事情发生了一些变化。 你可能想要：

class ModelFilter(django_filters.FilterSet):
    make = django_filters.ModelChoiceFilter(field_name='make__slug',
                                            to_field_name='slug',
                                            queryset=Make.objects.all())

    class Meta:
        model = Model
        fields = ('make',)

请参阅https://django-filter.readthedocs.io/en/master/ref/filters.html#field-name和https://django-filter.readthedocs.io/en/master/ref/filters.html#to -字段名称

Answer 4

在您看来，您需要做的事情是这样的：它被称为“跨越关系的查找”

queryset = Model.objects.filter(make__name__exact='Alfa Romeo')

具有特定发动机容量的模型的过滤是相似的

queryset = Model.objects.filter(engine_capacity__exact=5)

如果你想结合两个过滤器，你可以链接它们：

queryset = Model.objects.filter(make__name__exact='Alfa Romeo').filter(engine_capacity__exact=5)

可以在此处找到更多示例django 查询制作