Django REST Filter Backend Fix

In this tutorial, you'll learn about Django REST Filter Backend Fix. We cover key concepts, practical examples, and best practices.

The Problem

DRF list views return all objects by default. Without filter backends, clients must retrieve the entire dataset and filter client-side, wasting bandwidth and memory.

Quick Fix

Wrong — no filtering, returns everything

class ProductViewSet(viewsets.ModelViewSet):
    queryset = Product.objects.all()
    serializer_class = ProductSerializer

Output: GET /products/ returns every product in the database. No pagination or filtering.

Correct — DjangoFilterBackend

from django_filters.rest_framework import DjangoFilterBackend

class ProductViewSet(viewsets.ModelViewSet):
    queryset = Product.objects.all()
    serializer_class = ProductSerializer
    filter_backends = [DjangoFilterBackend]
    filterset_fields = ['category', 'is_active', 'price']

Output: GET /products/?category=electronics&is_active=true returns filtered results at the database level.

Combined backends

from rest_framework.filters import SearchFilter, OrderingFilter

class ProductViewSet(viewsets.ModelViewSet):
    filter_backends = [DjangoFilterBackend, SearchFilter, OrderingFilter]
    filterset_fields = ['category', 'is_active']
    search_fields = ['name', 'description']
    ordering_fields = ['price', 'created_at']

Custom FilterSet

import django_filters

class ProductFilter(django_filters.FilterSet):
    min_price = django_filters.NumberFilter(field_name='price', lookup_expr='gte')
    max_price = django_filters.NumberFilter(field_name='price', lookup_expr='lte')
    in_stock = django_filters.BooleanFilter(field_name='stock', lookup_expr='gt', method='filter_stock')

    class Meta:
        model = Product
        fields = ['category', 'min_price', 'max_price']

class ProductViewSet(viewsets.ModelViewSet):
    filter_backends = [DjangoFilterBackend]
    filterset_class = ProductFilter

Prevention

• Always add at least one filter backend to list endpoints.
• Use DjangoFilterBackend for exact matches and range filters.
• Use SearchFilter for text search across multiple fields.

Common Mistakes with rest filter backend

1. Using foldl instead of foldl' causing stack overflow on large lists
2. Forgetting deriving (Show, Eq) on custom data types needed for debugging
3. Placing the wildcard pattern first in case expressions, making all subsequent patterns unreachable

These mistakes appear frequently in real-world DJANGO code. DodaTech's contributors have identified these patterns through analysis of open-source projects and production systems.

Practice Exercise

Write a pure function that safely divides two integers using Maybe, then test it with edge cases like division by zero and negative numbers.

This exercise reinforces the concepts covered in this guide. Try implementing it before checking online solutions.

FAQ