Skip to main content

Fine tuning for serialized fields

Project description

drf-optionalfields gives you the flexibility to specify which fields you want to serialized.

There are two mixins available: OptionalFieldsMixin: Which allows you to set some optional fields. These fields can be requested via GET params DynamicFilterMixin: Which allows you to specify only the fields you need.

from rest_framework.serializers import ModelSerializer
from drf_optionalfields import OptionalFieldsMixin

class MyModelSerializer(OptionalFieldsMixin, ModelSerializer):
    class Meta:
        model = SomeModel
        fields = ("id", "username", "address", "full_name")
        optional_fields = ("address", "full_name")
# or combined with DynamicFilterMixin
class MyModelSerializer(OptionalFieldsMixin, DynamicFilterMixin, ModelSerializer):
    class Meta:
        model = SomeModel
        fields = ("id", "username", "address", "full_name")
        optional_fields = ("address", "full_name")
# You want to see an "address" you have set in the Meta:
GET /users/1/?fields=address

# You want only to return "username":
GET /users/1/?filter=username

# You want only to return the optional "full_name":
GET /users/1/?fields=full_name&filter=username

Thanks to Wim Glen for providing great bootstrap code with <https://github.com/wimglenn/djangorestframework-queryfields>(djangorestframework-queryfields)

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
drf-optionalfields-0.9.14.tar.gz (3.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page