Django Rest Framework: Dynamicznie zwracaj podzbiór pól

102

Problem

Zgodnie z zaleceniami zamieszczonymi w blogu Best Practices for Designing a Pragmatic RESTful API , chciałbym dodać fieldsparametr zapytania do interfejsu API opartego na Django Rest Framework, który pozwala użytkownikowi wybrać tylko podzbiór pól na zasób.

Przykład

Serializator:

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

Zwykłe zapytanie zwróciłoby wszystkie pola.

GET /identities/

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

Zapytanie z fieldsparametrem powinno zwracać tylko podzbiór pól:

GET /identities/?fields=id,data

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

Zapytanie z nieprawidłowymi polami powinno albo zignorować nieprawidłowe pola, albo zgłosić błąd klienta.

Cel

Czy jest to jakoś możliwe po wyjęciu z pudełka? Jeśli nie, jaki jest najprostszy sposób na wdrożenie tego? Czy istnieje pakiet innej firmy, który już to robi?

django  django-rest-framework 
— Danilo Bargen
źródło

Odpowiedzi:

124

Możesz zastąpić __init__metodę serializatora i ustawić fieldsatrybut dynamicznie, na podstawie parametrów zapytania. Możesz uzyskać dostęp do requestobiektu w całym kontekście, przekazanego do serializatora.

Oto przykład kopiowania i wklejania z dokumentacji Django Rest Framework w tej sprawie:

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')
— YAtOff
źródło
4
W końcu przyszedłem, aby to zaimplementować i działa idealnie! Dzięki. Skończyło się na tym, że napisałem mixin, kompozycja jest nieco bardziej elastyczna niż podklasy :) gist.github.com/dbrgn/4e6fc1fe5922598592d6
— Danilo Bargen
8
Będziesz musiał zmienić QUERY_PARAMSna query_paramsw ostatnich wersjach Django, ale poza tym działa to jak urok.
— Myk Willis
3
Prawdopodobnie powinieneś sprawdzić, czy requestsistnieje jako członek context. Chociaż działa to w środowisku produkcyjnym, nie dzieje się tak podczas uruchamiania testów jednostkowych, które ręcznie tworzą obiekty.
— smitec
21
Do Twojej wiadomości: Ten przykład jest dosłowną kopią dokumentacji DRF, którą można znaleźć tutaj: django-rest-framework.org/api-guide/serializers/#example To zły formularz, aby nie podawać linków do oryginalnych autorów
— Alex Bausk
3
Dokumentacja DRF , z której skopiowano tę odpowiedź, została ulepszona od czasu opublikowania tej odpowiedzi.
— Chris
51

Ta funkcja jest dostępna w pakiecie innej firmy .

pip install djangorestframework-queryfields

Zadeklaruj swój serializator w ten sposób:

from rest_framework.serializers import ModelSerializer
from drf_queryfields import QueryFieldsMixin

class MyModelSerializer(QueryFieldsMixin, ModelSerializer):
    ...

Następnie pola można teraz określić (po stronie klienta) za pomocą argumentów zapytania:

GET /identities/?fields=id,data

Możliwe jest również filtrowanie wykluczeń, np. Aby zwrócić każde pole oprócz id:

GET /identities/?fields!=id

zastrzeżenie: jestem autorem / opiekunem.

— wim
źródło
1
Cześć. Jaka jest różnica między this a github.com/dbrgn/drf-dynamic-fields (jak podano w komentarzach do wybranej odpowiedzi)?
— Danilo Bargen
5
Dzięki, przyjrzałem się tej implementacji i wygląda na to, że to ten sam podstawowy pomysł. Ale dbrgnimplementacja ma pewne różnice: 1. nie obsługuje wykluczania z fields!=key1,key2. 2. modyfikuje również serializatory poza kontekstem żądania GET, co może i będzie przerywać niektóre żądania PUT / POST. 3. nie gromadzi pól z np. fields=key1&fields=key2, Co jest miłe do posiadania dla aplikacji Ajax. Ma również zerowe pokrycie testowe, co jest nieco niezwykłe w OSS.
— wim
1
@wim Jakie wersje DRF i Django obsługuje Twoja biblioteka? Nie znalazłem nic w dokumentach.
— pawelswiecki
1
Django 1.7-1.11 +, w zasadzie każda konfiguracja obsługiwana przez DRF. Ten komentarz może być nieaktualny, więc sprawdź macierz testów dla CI tutaj .
— wim
1
U mnie działa świetnie: Django == 2.2.7, djangorestframework == 3.10.3, djangorestframework-queryfields == 1.0.0
— Neeraj Kashyap
7

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
— Austin Malerba
źródło
3

Skonfiguruj nową klasę serializatora stronicowania

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',
}

Utwórz dynamiczny serializator

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):
    # [...]

Na koniec użyj domysłów do swoich APIViews

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):
    # [...]

Żądanie

Teraz, gdy żądasz zasobu, możesz dodać parametr, fieldsaby wyświetlić tylko określone pola w adresie URL. /?fields=field1,field2

Możesz znaleźć przypomnienie tutaj: https://gist.github.com/Kmaschta/e28cf21fb3f0b90c597a

— Kmaschta
źródło
2

Możesz wypróbować Dynamic REST , który obsługuje pola dynamiczne (włączanie, wykluczanie), obiekty osadzone / wczytywane z boku, filtrowanie, porządkowanie, paginację i inne.

— blueFast
źródło
1

W przypadku danych zagnieżdżonych używam Django Rest Framework z pakietem zalecanym w dokumentacji , drf-flexfields

Pozwala to ograniczyć pola zwracane zarówno w obiekcie nadrzędnym, jak i podrzędnym. Instrukcje w pliku readme są dobre, tylko kilka rzeczy, na które należy uważać:

Wydaje się, że adres URL wymaga / like this „/ person /? Expand = country & fields = id, name, country” zamiast zapisanego w pliku readme „/ person? Expand = country & fields = id, name, country”

Nazewnictwo zagnieżdżonego obiektu i jego nazwa pokrewna muszą być całkowicie spójne, co w innym przypadku nie jest wymagane.

Jeśli masz „wiele”, np. Kraj może mieć wiele stanów, musisz ustawić „wiele”: Prawda w Serializatorze, jak opisano w dokumentacji.

— Mały mózg
źródło
1

Jeśli chcesz czegoś elastycznego, takiego jak GraphQL, możesz użyć django-restql . Obsługuje zagnieżdżone dane (zarówno płaskie, jak i iterowalne).

Przykład

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')

Zwykłe żądanie zwraca wszystkie pola.

GET /users

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

Z querydrugiej strony żądanie z parametrem zwraca tylko podzbiór pól:

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

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

Dzięki django-restql możesz uzyskać dostęp do zagnieżdżonych pól na dowolnym poziomie. Na przykład

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

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

Dla iterowalnych pól zagnieżdżonych, np. Grupy użytkowników.

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

    [
      {
        "id": 1,
        "username": "yezyilomo",
        "groups": [
            {
                "id": 2,
                "name": "Auth_User"
            }
        ]
      },
      ...
    ]
— Yezy Ilomo
źródło
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.