具有多个查询参数和外键的DRF过滤

时间:2020-05-06 20:53:41

标签: python django django-rest-framework filtering

我是Django的新手,正在尝试创建一条可调用的路线以从数据库中检索车辆数组,但是我希望用户能够在url中提供多个查询参数(像:http://127.0.0.1:8000/vehicles/?year=2020&make=Toyota)。我遇到的问题是,我的车辆模型包括对make和v_model的外键的引用(如此命名是为了避免与Django“ model”冲突)。我有一个似乎不太优雅的解决方案。每个搜索字段都有三个嵌套的条件语句,这一事实使我感到怀疑。我尝试使用“ filters.SearchFilter”,但是我只能提供一个作为搜索基础的值。因此,这样的请求:http://127.0.0.1:8000/vehicles/?search=2020&search=Toyota将仅搜索带有“ Toyota”品牌的车辆,而忽略“ year”参数。

还有其他更清洁或更“经Django批准”的方法吗?

这是我的代码:

models.py:

class Make(models.Model):
    name = models.CharField(max_length=200, unique=True)
    def __str__(self):
        return self.name


class VModel(models.Model):
    name = models.CharField(max_length=200, unique=True)
    make = models.ForeignKey(Make, on_delete=models.CASCADE)
    def __str__(self):
        return self.name


class Vehicle(models.Model):
    make = models.ForeignKey(Make, on_delete=models.CASCADE)
    v_model = models.ForeignKey(VModel, on_delete=models.CASCADE)
    year = models.CharField(max_length=5)
    def __str__(self):
        return self.year + " " + self.v_model.name

views.py:

这是我尝试使用filter.SearchFilter:

    queryset = Vehicle.objects.all()
    serializer_class = VehicleSerializer
    filter_backends = [filters.SearchFilter]
    search_fields = ['year', 'v_model__name','make__name']

这是我似乎很棘手的“有效”解决方案: (注意:我使用的是name__icontains,因此,如果用户输入“ Toyot”,它仍然会获得所有带有Toyota品牌的汽车。)

class VehicleListViewSet(viewsets.ModelViewSet):
    serializer_class = VehicleSerializer
    queryset = Vehicle.objects.all()
    pagination_class = CustomPagination


    def get_queryset(self):
        qs = super().get_queryset()
        selected_make = self.request.query_params.get('make', None)
        if selected_make:
            try:
                found_make = Make.objects.get(name__icontains=selected_make)
            except:
                return []
            if found_make:
                if found_make.id:
                    qs = qs.filter(make=found_make.id)
        selected_v_model = self.request.query_params.get('v_model', None)
        if selected_v_model:
            try:
                found_v_model = VModel.objects.get(name__icontains=selected_v_model)
            except:
                return []
            if found_v_model:
                if found_v_model.id:
                    qs = qs.filter(v_model=found_v_model.id)
        selected_year = self.request.query_params.get('year', None)
        if selected_year:
            qs = qs.filter(year=selected_year)
        return qs

1 个答案:

答案 0 :(得分:0)

您不应该使用filters.SearchFilter。而是在ViewSet中使用filterset_fields属性,例如this section of the documentation中的示例。

您的视图集将是这样的:

class VehicleListViewSet(viewsets.ModelViewSet):
    serializer_class = VehicleSerializer
    queryset = Vehicle.objects.all()
    pagination_class = CustomPagination
    filter_backends = [DjangoFilterBackend]
    filterset_fields = ['year', 'v_model__name','make__name']

(请注意,没有get_queryset覆盖),您将可以像这样查询您的API:

http://127.0.0.1:8000/vehicles/?year=2020&make__name=Toyota&v_model__name=Corolla