API如何根据GET请求中的多个键值对过滤django中的对象？

Question

我的 django 项目的“urls.py”文件夹中有一个 API url：-

path('tests/filter/<str:key1>/<str:value1>', FilterTests.as_view())

这适用于以下代码：-

from rest_framework import generics
from service.models import Test
from service.serializers import TestListSerializer


class FilterTests(generics.ListAPIView):
    queryset = Test.objects.all()
    serializer_class = TestListSerializer

    def get_queryset(self, *args, **kwargs):
        key1 = self.kwargs['key1']
        value1 = self.kwargs['value1']
        return Test.objects.filter(**{key1: value1})

上面的代码仅根据 get 请求中传递的单个键值对过滤我的 Test 对象。 我现在想过滤超过 1 个键值对。

例如：- 过滤器应为：name=john&type_test=algo&count=3

我应该如何设计 django 中的 api 端点，而不是让 url 也太长？ 我可以通过请求正文使用 json 或 map 吗？ 我是 django 和 api 开发的初学者，因此我们将不胜感激。

Answer 1

你可以使用 django 过滤器。

pip 安装 django-filter

然后将 'django_filters' 添加到 Django 的 INSTALLED_APPS：

INSTALLED_APPS = [
    ...
    'django_filters',
    ...
]

将过滤器后端添加到您的设置

REST_FRAMEWORK = {
    'DEFAULT_FILTER_BACKENDS': ['django_filters.rest_framework.DjangoFilterBackend']
}

将过滤器后端添加到单个 View 或 ViewSet。

from django_filters.rest_framework import DjangoFilterBackend

class UserListView(generics.ListAPIView):
    ...
    filter_backends = [DjangoFilterBackend]


class ProductList(generics.ListAPIView):
    queryset = Product.objects.all()
    serializer_class = ProductSerializer
    filter_backends = [DjangoFilterBackend]
    filterset_fields = ['category', 'in_stock']

如果您只需要简单的基于相等的过滤，您可以在视图或视图集上设置 filterset_fields 属性，列出您希望过滤的字段集。

This will automatically create a FilterSet class for the given fields, and will allow you to make requests such as

http://example.com/api/products?category=clothing&in_stock=True

https://www.django-rest-framework.org/api-guide/filtering/