SearchFilter Example

A snippet showing how to use SearchFilter in DRF APIs.


# settings.py

REST_FRAMEWORK = {
    "DEFAULT_FILTER_BACKENDS": [
        "rest_framework.filters.SearchFilter",
    ],
}
      

# views.py

from rest_framework import viewsets
from .models import Article
from .serializers import ArticleModelSerializer

class ArticleViewSet(viewsets.ReadOnlyModelViewSet):
    queryset = Article.objects.all()
    serializer_class = ArticleModelSerializer
    search_fields = ["title", "body"]  # icontains lookup
      
Explanation:
  • Clients can search with ?search=keyword across specified fields.
Never miss a story on Django.wiki

Subscribe for fresh tutorials, snippets, and updates.

By subscribing you agree to our Privacy Policy.