Filtering & Pagination

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
    'PAGE_SIZE': 10,
}

{
  "count": 157,
  "next": "http://api.example.com/api/v1/products/?limit=10&offset=20",
  "previous": "http://api.example.com/api/v1/products/?limit=10&offset=0",
  "results": [
    {
      "id": 11,
      "name": "Product Name",
      // ... product fields
    },
    // ... more products
  ]
}

# Formula for offset
offset = (page_number - 1) * limit

# Example: Get page 5 with 20 items per page
# offset = (5 - 1) * 20 = 80
GET /api/v1/products/?limit=20&offset=80

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

class ProductListView(GenericAPIView):
    filterset_fields = ["category", "is_available", "store"]

path("products/categories/<slug:slug>/", ProductListView.as_view())

GET /api/v1/products/categories/electronics/
# Returns all products in the "electronics" category

class ProductListView(GenericAPIView):
    search_fields = ["name", "category__name", "label", "store__brand_name"]

class CategoryListView(ListAPIView):
    search_fields = ["name"]

GET /api/v1/categories/?search=electronics
# Returns categories matching "electronics"

GET /api/v1/products/?search=wireless&category=5&is_available=true&store=3&limit=20&offset=40

{
  "count": 87,
  "next": "http://api.example.com/api/v1/products/?search=wireless&category=5&is_available=true&store=3&limit=20&offset=60",
  "previous": "http://api.example.com/api/v1/products/?search=wireless&category=5&is_available=true&store=3&limit=20&offset=20",
  "results": [
    {
      "id": 41,
      "name": "Wireless Headphones Pro",
      "category": {
        "id": 5,
        "name": "Audio",
        "slug": "audio"
      },
      "store": {
        "id": 3,
        "brand_name": "TechStore"
      },
      "base_price": "149.99",
      "is_available": true,
      "rating": 4.5,
      "total_stock_level": 250
    }
    // ... 19 more products
  ]
}

class Product(BaseModel):
    class Meta:
        ordering = ["-total_sold", "-rating"]

class Order(BaseModel):
    class Meta:
        ordering = ["-created"]

// Request: GET /api/v1/products/?category=invalid
{
  "category": [
    "Enter a valid integer."
  ]
}

// Request: GET /api/v1/products/?is_available=yes
{
  "is_available": [
    "Must be a valid boolean."
  ]
}

class ProductListView(GenericAPIView, LimitOffsetPagination):
    permission_classes = [AllowAny]
    serializer_class = ProductListSerializer
    filterset_fields = ["category", "is_available", "store"]
    search_fields = ["name", "category__name", "label", "store__brand_name"]

    def get_queryset(self):
        queryset = Product.objects.all()
        queryset = self.filter_queryset(queryset)
        return queryset