問題

ブログ投稿の「実践的なRESTful APIを設計するためのベストプラクティス」で推奨されているようfieldsに、Django Rest FrameworkベースのAPIにクエリパラメーターを追加すると、ユーザーはリソースごとにフィールドのサブセットのみを選択できます。

例

シリアライザ：

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"
  },
  ...
]

無効なフィールドを含むクエリは、無効なフィールドを無視するか、クライアントエラーをスローする必要があります。

ゴール

これは、箱から出して何とかして可能ですか？そうでない場合、これを実装する最も簡単な方法は何ですか？すでにこれを行うサードパーティのパッケージはありますか？

クエリのパラメーターに基づいて、シリアライザー__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')

この機能は、サードパーティのパッケージから利用できます。

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

免責事項： 私は作者/メンテナーです。

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

新しいページネーションシリアライザークラスを構成する

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にhomemageミックスインを使用します

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

動的フィールド（包含、除外）、埋め込み/サイドローディングオブジェクト、フィルタリング、順序付け、ページネーションなどをサポートする動的RESTを試すことができます。

drf_tweaks / control-over-serialized-fieldsで提供したこのような機能。

シリアライザを使用する場合、必要なのは?fields=x,y,zクエリでパラメータを渡すことだけです。

ネストされたデータの場合、私はドキュメントで推奨されているパッケージdrf-flexfieldsでDjango Rest Frameworkを使用しています

これにより、親オブジェクトと子オブジェクトの両方で返されるフィールドを制限できます。Readmeの説明は適切ですが、注意すべき点がいくつかあります。

URLには、readme '/ person？expand = country＆fields = id、name、country'に書かれているのではなく、/ '/ person /？expand = country＆fields = id、name、country'のような/が必要なようです

ネストされたオブジェクトの名前とそれに関連する名前は、完全に一貫している必要があります。それ以外の場合は必要ありません。

たとえば「国」に「多数」がある場合、国に多くの州がある可能性がある場合は、ドキュメントに記載されているように、シリアライザで「多数」をTrueに設定する必要があります。

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"
      },
      ...
    ]

ジャンゴ-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"
            }
        ]
      },
      ...
    ]