如何在Django REST框架中更改URL中的默认搜索查询参数？

Question

在Django REST框架中。默认情况下，它使用-/？搜索=在URL中搜索任何内容。例如http://127.0.0.1:8000/api/branches/?search=RTGS 此url已成功获取结果。但我需要将URL更改为http://127.0.0.1:8000/api/branches/autocomplete?q=RTGS

在留档中，https://www.django-rest-framework.org/api-guide/settings/#search_param给出是默认设置的，https://www.django-rest-framework.org/api-guide/settings/#search_paramd我们可以更改。我想知道怎么做。

谢谢

https://www.django-rest-framework.org/api-guide/settings/#search_param

网址。来自django的py。URL导入路径，包括从。从rest_框架导入视图导入路由器

router = routers.DefaultRouter()
# router.register('bank', views.BankView)
router.register('branches/autocomplete', views.BankDetailView)
# router.register('branches/list', views.BankAPIListView)



urlpatterns = [
    path('api/', include(router.urls)),

]

views.py

from django.shortcuts import render, redirect
from rest_framework import viewsets
from .models import Branches
from .serializers import BranchesSerializer
from rest_framework import filters
from rest_framework.filters import OrderingFilter
from rest_framework.pagination import PageNumberPagination  
# from django_filters.rest_framework import DjangoFilterBackend





class BankDetailView(viewsets.ModelViewSet):
    queryset = Branches.objects.all()
    serializer_class = BranchesSerializer
    filter_backends = [filters.SearchFilter, OrderingFilter]
    # Partial Search with the field in branch
    search_fields = ['^branch']
    # Ordering Filter field by ifsc in ascending order
    # filter_backends = [DjangoFilterBackend]
    # filterset_fields = ['ifsc']

serializers.py

from rest_framework import serializers
from .models import Branches

class BranchesSerializer(serializers.HyperlinkedModelSerializer):
    class Meta :
        model = Branches
        fields = ['url' ,'ifsc', 'bank_id', 'branch', 'address', 'city', 
'district', 'state']

http://127.0.0.1:8000/api/branches/autocomplete?q=RTGS

Answer 1

如果只想在一个视图中更改查询参数键，可以扩展SearchFilter，然后将其添加到视图的filter\u backends。

class CustomSearchFilter(SearchFilter):
    search_param = "q"


class MyListView(ListAPIView):
    # ...
    filter_backends = [CustomSearchFilter]
    # ...

Answer 2

从文档中：

默认情况下，搜索参数名为'search'，但这可能会被搜索参数设置覆盖。

因此，在您的settings.py中：

REST_FRAMEWORK = {
    'SEARCH_PARAM': 'q'
}

编辑：

在这里您可以看到实际的代码：

设置：https://github.com/encode/django-rest-framework/blob/master/rest_framework/settings.py#L68

过滤器：https://github.com/encode/django-rest-framework/blob/master/rest_framework/filters.py#L42