drf-partial-response-fields 1.0.0

GraphQL-like sparse fieldsets and automatic query optimization for Django REST Framework

drf-partial-response-fields

GraphQL-like sparse fieldsets for Django REST Framework — with automatic select_related / prefetch_related / only() query optimization, so requesting fewer fields also means fewer queries and less data transferred.

GET /api/articles/1/?fields=title,author(name,email),tags(label)

{
  "title": "Shipping Faster with Sparse Fieldsets",
  "author": { "name": "Ada Lovelace", "email": "[e-mail]" },
  "tags": [{ "label": "performance" }, { "label": "django" }]
}

Why

Fetching the full representation of a resource is wasteful when a client only needs a few fields — especially on mobile, in list views, or in BFF-style aggregation layers. Most "sparse fieldset" implementations for DRF only filter the serializer output and leave the ORM query untouched, so you save bytes on the wire but still pay for every join and every SerializerMethodField query. This package does both: it filters what gets serialized and rewrites the queryset so the database only does the work that's actually needed.

Features

• Nested field selection: ?fields=title,author(name,email)
• Deep nesting: any depth, e.g. author(company(name,address(city)))
• Exclusion: ?fields=-internal_notes,-legacy_id
• Aliasing: ?fields=publishedAt:created_at
• Wildcards: ?fields=* (explicit "no restriction")
• Works with: ModelSerializer, nested serializers, SerializerMethodField, pagination, ViewSet/GenericAPIView/APIView, the Browsable API, and OpenAPI schema generation (via drf-spectacular)
• Automatic query optimization: select_related, prefetch_related (including recursively-optimized nested Prefetch querysets), and only() are derived from the requested fields — see docs/performance.md for measured query-count reductions.
• Safe by default: unrequested SerializerMethodFields are never invoked, so expensive computed fields only cost what they cost when a client actually asks for them.
• Fully typed, PEP 561 compatible, mypy --strict clean.

Installation

pip install drf-partial-response-fields

# with OpenAPI schema support
pip install drf-partial-response-fields[openapi]

Requires Python 3.10+, Django 4.2+, and Django REST Framework 3.14+.

Quick Start

# serializers.py
from rest_framework import serializers
from drf_partial_response_fields import PartialFieldsModelSerializer


class AuthorSerializer(PartialFieldsModelSerializer):
    class Meta:
        model = Author
        fields = ["id", "name", "email"]


class ArticleSerializer(PartialFieldsModelSerializer):
    author = AuthorSerializer()

    class Meta:
        model = Article
        fields = ["id", "title", "body", "author"]

# views.py
from rest_framework import viewsets
from drf_partial_response_fields import PartialResponseMixin


class ArticleViewSet(PartialResponseMixin, viewsets.ModelViewSet):
    queryset = Article.objects.all()
    serializer_class = ArticleSerializer

That's it — GET /articles/?fields=title,author(name) now returns only title and author.name, and the underlying queryset automatically gets select_related("author").only("id", "title", "author__id", "author__name").

See docs/quickstart.md and docs/advanced-usage.md for aliasing, exclusion, SerializerMethodField optimization hints, and plain-APIView integration.

Documentation

Full documentation is available at https://mahmoudgshaker.github.io/drf-partial-response-fields/, including:

• Getting Started
• Installation
• Configuration / Settings
• Quick Start
• Advanced Usage
• Architecture
• API Reference
• Examples
• Common Patterns
• Performance
• Security
• Testing
• Deployment
• FAQ
• Troubleshooting

Contributing

Contributions are welcome — see CONTRIBUTING.md.

License

MIT — see LICENSE.