Problema

Come consigliato nel blogpost Best Practices for Designing a Pragmatic RESTful API , vorrei aggiungere un fieldsparametro di query a un'API basata su Django Rest Framework che consente all'utente di selezionare solo un sottoinsieme di campi per risorsa.

Esempio

Serializzatore:

class IdentitySerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = models.Identity
        fields = ('id', 'url', 'type', 'data')

Una query regolare restituirebbe tutti i campi.

GET /identities/

[
  {
    "id": 1,
    "url": "http://localhost:8000/api/identities/1/",
    "type": 5,
    "data": "John Doe"
  },
  ...
]

Una query con il fieldsparametro dovrebbe restituire solo un sottoinsieme dei campi:

GET /identities/?fields=id,data

[
  {
    "id": 1,
    "data": "John Doe"
  },
  ...
]

Una query con campi non validi dovrebbe ignorare i campi non validi o generare un errore del client.

Obbiettivo

È possibile in qualche modo fuori dagli schemi? In caso contrario, qual è il modo più semplice per implementarlo? Esiste un pacchetto di terze parti in giro che lo fa già?

È possibile sovrascrivere il __init__metodo serializer e impostare l' fieldsattributo dinamicamente, in base ai parametri della query. È possibile accedere requestall'oggetto in tutto il contesto, passato al serializzatore.

Ecco un esempio di documentazione di Django Rest Framework sull'argomento: copia e incolla :

from rest_framework import serializers

class DynamicFieldsModelSerializer(serializers.ModelSerializer):
    """
    A ModelSerializer that takes an additional `fields` argument that
    controls which fields should be displayed.
    """

    def __init__(self, *args, **kwargs):
        # Instantiate the superclass normally
        super(DynamicFieldsModelSerializer, self).__init__(*args, **kwargs)

        fields = self.context['request'].query_params.get('fields')
        if fields:
            fields = fields.split(',')
            # Drop any fields that are not specified in the `fields` argument.
            allowed = set(fields)
            existing = set(self.fields.keys())
            for field_name in existing - allowed:
                self.fields.pop(field_name)


class UserSerializer(DynamicFieldsModelSerializer, serializers.HyperlinkedModelSerializer):

    class Meta:
        model = User
        fields = ('url', 'username', 'email')

Questa funzionalità è disponibile da a pacchetto di terze parti .

pip install djangorestframework-queryfields

Dichiara il tuo serializzatore in questo modo:

from rest_framework.serializers import ModelSerializer
from drf_queryfields import QueryFieldsMixin

class MyModelSerializer(QueryFieldsMixin, ModelSerializer):
    ...

Quindi i campi possono ora essere specificati (lato client) utilizzando gli argomenti della query:

GET /identities/?fields=id,data

È anche possibile il filtro di esclusione, ad esempio per restituire ogni campo eccetto id:

GET /identities/?fields!=id

disclaimer: sono l'autore / manutentore.

serializers.py

class DynamicFieldsSerializerMixin(object):

    def __init__(self, *args, **kwargs):
        # Don't pass the 'fields' arg up to the superclass
        fields = kwargs.pop('fields', None)

        # Instantiate the superclass normally
        super(DynamicFieldsSerializerMixin, self).__init__(*args, **kwargs)

        if fields is not None:
            # Drop any fields that are not specified in the `fields` argument.
            allowed = set(fields)
            existing = set(self.fields.keys())
            for field_name in existing - allowed:
                self.fields.pop(field_name)


class UserSerializer(DynamicFieldsSerializerMixin, serializers.HyperlinkedModelSerializer):

    password = serializers.CharField(
        style={'input_type': 'password'}, write_only=True
    )

    class Meta:
        model = User
        fields = ('id', 'username', 'password', 'email', 'first_name', 'last_name')


    def create(self, validated_data):
        user = User.objects.create(
            username=validated_data['username'],
            email=validated_data['email'],
            first_name=validated_data['first_name'],
            last_name=validated_data['last_name']
        )

        user.set_password(validated_data['password'])
        user.save()

        return user

views.py

class DynamicFieldsViewMixin(object):

 def get_serializer(self, *args, **kwargs):

    serializer_class = self.get_serializer_class()

    fields = None
    if self.request.method == 'GET':
        query_fields = self.request.QUERY_PARAMS.get("fields", None)

        if query_fields:
            fields = tuple(query_fields.split(','))


    kwargs['context'] = self.get_serializer_context()
    kwargs['fields'] = fields

    return serializer_class(*args, **kwargs)



class UserList(DynamicFieldsViewMixin, ListCreateAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer

Configurare una nuova classe serializzatore di paginazione

from rest_framework import pagination, serializers

class DynamicFieldsPaginationSerializer(pagination.BasePaginationSerializer):
    """
    A dynamic fields implementation of a pagination serializer.
    """
    count = serializers.Field(source='paginator.count')
    next = pagination.NextPageField(source='*')
    previous = pagination.PreviousPageField(source='*')

    def __init__(self, *args, **kwargs):
        """
        Override init to add in the object serializer field on-the-fly.
        """
        fields = kwargs.pop('fields', None)
        super(pagination.BasePaginationSerializer, self).__init__(*args, **kwargs)
        results_field = self.results_field
        object_serializer = self.opts.object_serializer_class

        if 'context' in kwargs:
            context_kwarg = {'context': kwargs['context']}
        else:
            context_kwarg = {}

        if fields:
            context_kwarg.update({'fields': fields})

        self.fields[results_field] = object_serializer(source='object_list',
                                                       many=True,
                                                       **context_kwarg)


# Set the pagination serializer setting
REST_FRAMEWORK = {
    # [...]
    'DEFAULT_PAGINATION_SERIALIZER_CLASS': 'DynamicFieldsPaginationSerializer',
}

Crea serializzatore dinamico

from rest_framework import serializers

class DynamicFieldsModelSerializer(serializers.ModelSerializer):
    """
    A ModelSerializer that takes an additional `fields` argument that
    controls which fields should be displayed.

    See:
        http://tomchristie.github.io/rest-framework-2-docs/api-guide/serializers
    """

    def __init__(self, *args, **kwargs):
        # Don't pass the 'fields' arg up to the superclass
        fields = kwargs.pop('fields', None)

        # Instantiate the superclass normally
        super(DynamicFieldsModelSerializer, self).__init__(*args, **kwargs)

        if fields:
            # Drop any fields that are not specified in the `fields` argument.
            allowed = set(fields)
            existing = set(self.fields.keys())
            for field_name in existing - allowed:
                self.fields.pop(field_name)
# Use it
class MyPonySerializer(DynamicFieldsModelSerializer):
    # [...]

Infine, usa un mixin di homemage per le tue APIVview

class DynamicFields(object):
    """A mixins that allows the query builder to display certain fields"""

    def get_fields_to_display(self):
        fields = self.request.GET.get('fields', None)
        return fields.split(',') if fields else None

    def get_serializer(self, instance=None, data=None, files=None, many=False,
                       partial=False, allow_add_remove=False):
        """
        Return the serializer instance that should be used for validating and
        deserializing input, and for serializing output.
        """
        serializer_class = self.get_serializer_class()
        context = self.get_serializer_context()
        fields = self.get_fields_to_display()
        return serializer_class(instance, data=data, files=files,
                                many=many, partial=partial,
                                allow_add_remove=allow_add_remove,
                                context=context, fields=fields)

    def get_pagination_serializer(self, page):
        """
        Return a serializer instance to use with paginated data.
        """
        class SerializerClass(self.pagination_serializer_class):
            class Meta:
                object_serializer_class = self.get_serializer_class()

        pagination_serializer_class = SerializerClass
        context = self.get_serializer_context()
        fields = self.get_fields_to_display()
        return pagination_serializer_class(instance=page, context=context, fields=fields)

class MyPonyList(DynamicFields, generics.ListAPIView):
    # [...]

Richiesta

Ora, quando richiedi una risorsa, puoi aggiungere un parametro fieldsper mostrare solo i campi specificati nell'URL. /?fields=field1,field2

Puoi trovare un promemoria qui: https://gist.github.com/Kmaschta/e28cf21fb3f0b90c597a

Potresti provare Dynamic REST , che supporta i campi dinamici (inclusione, esclusione), oggetti incorporati / trasferiti lateralmente, filtri, ordinamento, impaginazione e altro.

Tale funzionalità è stata fornita in drf_tweaks / control-over-serialized-fields .

Se utilizzi i nostri serializzatori, tutto ciò di cui hai bisogno è passare il ?fields=x,y,zparametro nella query.

Per i dati nidificati, sto usando Django Rest Framework con il pacchetto consigliato nella documentazione , drf-flexfields

Ciò consente di limitare i campi restituiti sugli oggetti padre e figlio. Le istruzioni nel file readme sono buone, solo alcune cose a cui prestare attenzione:

L'URL sembra aver bisogno di / come questo "/ person /? Expand = country & fields = id, name, country" anziché come scritto nel file readme "/ person? Expand = country & fields = id, name, country"

La denominazione dell'oggetto annidato e il suo nome correlato devono essere completamente coerenti, il che non è richiesto altrimenti.

Se hai "molti", ad esempio un paese può avere molti stati, dovrai impostare "molti": True nel Serializer come descritto nei documenti.

Se vuoi qualcosa di flessibile come GraphQL, puoi usare django-restql . Supporta dati nidificati (sia flat che iterabili).

Esempio

from rest_framework import serializers
from django.contrib.auth.models import User
from django_restql.mixins import DynamicFieldsMixin

class UserSerializer(DynamicFieldsMixin, serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ('id', 'username', 'email', 'groups')

Una richiesta regolare restituisce tutti i campi.

GET /users

    [
      {
        "id": 1,
        "username": "yezyilomo",
        "email": "yezileliilomo@hotmail.com",
        "groups": [1,2]
      },
      ...
    ]

Una richiesta con il queryparametro invece restituisce solo un sottoinsieme dei campi:

GET /users/?query={id, username}

    [
      {
        "id": 1,
        "username": "yezyilomo"
      },
      ...
    ]

Con django-restql puoi accedere a campi annidati di qualsiasi livello. Per esempio

GET /users/?query={id, username, date_joined{year}}

    [
      {
        "id": 1,
        "username": "yezyilomo",
        "date_joined": {
            "year": 2018
        }
      },
      ...
    ]

Per i campi nidificati iterabili, ad es. Gruppi sugli utenti.

GET /users/?query={id, username, groups{id, name}}

    [
      {
        "id": 1,
        "username": "yezyilomo",
        "groups": [
            {
                "id": 2,
                "name": "Auth_User"
            }
        ]
      },
      ...
    ]