Django Rest Framework: динамический возврат подмножества полей

102

Проблема

В соответствии с рекомендациями в блоге Best Practices for Designing a Pragmatic RESTful API , я хотел бы добавить fieldsпараметр запроса в API на основе Django Rest Framework, который позволяет пользователю выбирать только подмножество полей для каждого ресурса.

пример

Сериализатор:

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

Обычный запрос вернет все поля.

GET /identities/

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

Запрос с fieldsпараметром должен возвращать только подмножество полей:

GET /identities/?fields=id,data

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

Запрос с недопустимыми полями должен либо игнорировать недопустимые поля, либо вызывать ошибку клиента.

Цель

Такое возможно как-то из коробки? Если нет, то как это проще всего реализовать? Есть ли сторонний пакет, который это уже делает?

django  django-rest-framework 
— Данило Барген
источник

Ответы:

124

Вы можете переопределить __init__метод сериализатора и установить fieldsатрибут динамически на основе параметров запроса. Вы можете получить доступ к requestобъекту через контекст, переданный в сериализатор.

Вот копия и вставка из примера документации Django Rest Framework по этому вопросу:

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
источник
4
Я наконец нашел способ реализовать это, и он отлично работает! Спасибо. В итоге я написал миксин для этого, композиция немного более гибкая, чем подклассы :) gist.github.com/dbrgn/4e6fc1fe5922598592d6
— Данило Барген
8
В последних версиях Django вам нужно будет изменить QUERY_PARAMSна query_params, но в остальном это работает как шарм.
— Майк Уиллис
3
Вам, вероятно, следует проверить, что requestsсуществует как член context. В производственной среде этого не происходит при запуске модульных тестов, которые создают объекты вручную.
— smitec
21
К вашему сведению: этот пример представляет собой дословную копию документации DRF, найденной здесь: django-rest-framework.org/api-guide/serializers/#example. Не предоставлять ссылку на оригинальных авторов
— Алекс Бауск
3
Документация DRF , из которой был скопирован этот ответ, была улучшена с момента публикации этого ответа.
— Крис
51

Эта функция доступна из стороннего пакета .

pip install djangorestframework-queryfields

Объявите свой сериализатор следующим образом:

from rest_framework.serializers import ModelSerializer
from drf_queryfields import QueryFieldsMixin

class MyModelSerializer(QueryFieldsMixin, ModelSerializer):
    ...

Затем поля теперь можно указать (на стороне клиента) с помощью аргументов запроса:

GET /identities/?fields=id,data

Также возможна фильтрация исключения, например, для возврата всех полей, кроме id:

GET /identities/?fields!=id

отказ от ответственности: я автор / сопровождающий.

— вим
источник
1
Здравствуй. В чем разница между этим и github.com/dbrgn/drf-dynamic-fields (как указано в комментариях к выбранному ответу)?
— Данило Барген
5
Спасибо, я посмотрел на эту реализацию, и похоже, что это та же основная идея. Но dbrgnреализация имеет некоторые отличия: 1. не поддерживает исключение с помощью fields!=key1,key2. 2. также изменяет сериализаторы вне контекста запроса GET, что может нарушить и нарушит некоторые запросы PUT / POST. 3. не накапливает поля, например fields=key1&fields=key2, что удобно для приложений ajax. Он также имеет нулевое тестовое покрытие, что несколько необычно для OSS.
— wim
1
@wim Какие версии DRF и Django поддерживает ваша библиотека? Я ничего не нашел в документации.
— pawelswiecki
1
Django 1.7-1.11 +, практически любая конфигурация, поддерживаемая DRF. Этот комментарий может устареть, поэтому проверьте тестовую матрицу для CI здесь .
— wim
1
У меня отлично работает: Django == 2.2.7, djangorestframework == 3.10.3, djangorestframework-queryfields == 1.0.0
— Neeraj
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
— Остин Малерба
источник
3

Настройте новый класс сериализатора пагинации

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

Сделать динамический сериализатор

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

Наконец, используйте миксин домашнего мастера для ваших 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):
    # [...]

Запрос

Теперь, когда вы запрашиваете ресурс, вы можете добавить параметр, fieldsчтобы отображать только указанные поля в URL-адресе. /?fields=field1,field2

Здесь вы можете найти напоминание: https://gist.github.com/Kmaschta/e28cf21fb3f0b90c597a

— Kmaschta
источник
2

Вы можете попробовать Dynamic REST , который поддерживает динамические поля (включение, исключение), встроенные / загруженные неопубликованные объекты, фильтрацию, упорядочивание, разбиение на страницы и многое другое.

— blueFast
источник
1

Для вложенных данных я использую Django Rest Framework с пакетом, рекомендованным в документации , drf-flexfields

Это позволяет вам ограничивать поля, возвращаемые как для родительских, так и для дочерних объектов. Инструкции в readme хороши, всего несколько вещей, на которые следует обратить внимание:

Похоже, что URL-адрес нуждается в / как это '/ person /? Expand = country & fields = id, name, country' вместо того, как написано в файле readme '/ person? Expand = country & fields = id, name, country'

Именование вложенного объекта и связанное с ним имя должны быть полностью согласованными, в противном случае этого не требуется.

Если у вас есть «много», например, в стране может быть много состояний, вам нужно установить «многие»: True в сериализаторе, как описано в документации.

— Маленький мозг
источник
1

Если вам нужно что-то гибкое, например GraphQL, вы можете использовать django-restql . Он поддерживает вложенные данные (как плоские, так и повторяемые).

пример

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

Обычный запрос возвращает все поля.

GET /users

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

С queryдругой стороны, запрос с параметром возвращает только подмножество полей:

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

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

С помощью django-restql вы можете получить доступ к вложенным полям любого уровня. Например

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

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

Для повторяемых вложенных полей, например, групп по пользователям.

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

    [
      {
        "id": 1,
        "username": "yezyilomo",
        "groups": [
            {
                "id": 2,
                "name": "Auth_User"
            }
        ]
      },
      ...
    ]
— Ези Иломо
источник
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.