drf-ordering-mapper 0.0.1

A Django REST Framework filter to map ordering query parameters to ORM fields

drf-ordering-mapper

Small utility for Django REST Framework to map ordering query params to actual ORM fields.

Why?

DRF’s OrderingFilter works well, but you often end up exposing internal field paths like:

?ordering=company__commodity_name

That’s not great for API consumers.

This package lets you do:

?ordering=commodity_name

and map it internally.

---

Installation

pip install drf-ordering-mapper

---

Usage

from drf_ordering_mapper.filters import OrderingMapperFilter

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

    filter_backends = [OrderingMapperFilter]

    ordering_fields = ['commodity_name', 'price']

    ordering_params_mapping = {
        'commodity_name': 'company__commodity_name'
    }

---

Example

Request:

GET /api/products?ordering=commodity_name

Internally becomes:

queryset.order_by('company__commodity_name')

---

Descending:

GET /api/products?ordering=-commodity_name

---

Multiple fields:

GET /api/products?ordering=commodity_name,-price

---

Notes

• Works as a drop-in replacement for DRF’s OrderingFilter
• Respects ordering_fields
• Ignores invalid fields (same behavior as DRF)