django-rest-framework 序列化器在多个视图中的不同字段
django-rest-framework serializer different fields in multiple views
我是 Django 的新手,找不到解决我的问题的方法。
问题是在使用不同视图的情况下,强制特定的序列化程序包含不同数量的字段。我想在第一个视图和第二个视图中使用 'id' 字段 - 'id' 和 'name' 字段。
这是我的 model.py
class Processing(models.Model):
id = models.AutoField(primary_key=True)
name = models.CharField()
description = models.CharField()
这是我的 serializer.py
class ProcessingSerializer(serializers.ModelSerializer):
id = serializers.ModelField(model_field=Processing()._meta.get_field('id'))
class Meta:
model = Processing
fields = ('id', 'name')
欢迎任何帮助。
class DynamicFieldsModelSerializer(ModelSerializer):
"""
A ModelSerializer that takes an additional `fields` and 'exclude' argument that
controls which fields should be displayed.
"""
def __init__(self, *args, **kwargs):
# Don't pass the 'fields' arg up to the superclass
fields = kwargs.pop('fields', None)
exclude = kwargs.pop('exclude', None)
# Instantiate the superclass normally
super(DynamicFieldsModelSerializer, 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)
if exclude is not None:
not_allowed = set(exclude)
for exclude_name in not_allowed:
self.fields.pop(exclude_name)
class UserCreateSerializer(DynamicFieldsModelSerializer):
class Meta:
model = User
fields = ('username', 'tel', 'email', 'password')
使用:
serializer = UserCreateSerializer(data=request.data, fields=('username', 'password', 'tel'))
或
serializer = UserCreateSerializer(data=request.data, fields=('username', 'password', 'email'))
当有人刚开始使用 DRF 时,一个常见的错误是试图让同一个序列化程序在阳光下做所有事情。当然,我自己也走上了这条路。
但是当您为不同的任务使用多个序列化程序时,生活会变得简单得多。您可以使用 get_serializer_class 方法轻松切换序列化器。这是手册中的一个示例,说明如何为管理员使用一个,为普通用户使用另一个
def get_serializer_class(self):
if self.request.user.is_staff:
return FullAccountSerializer
return BasicAccountSerializer
有时您希望对列表使用一个序列化器,而在提供详细信息时使用另一个序列化器。尝试这样的事情:
def get_serializer_class(self):
if self.action == 'retrieve':
return serializers.PlayerDetailSerializer
else :
return serializers.PlayerSerializer
这样生活就简单多了。
您还可以使用下一种方法:
class SelectSerializerMixin(object):
serializer_class = None
list_serializer_class = None
retrieve_serializer_class = None
update_serializer_class = None
partial_update_serializer_class = None
create_serializer_class = None
def get_serializer_class(self):
"""
Return the class to use for the serializer.
Defaults to using `self.serializer_class`.
"""
assert self.serializer_class is not None, (
"'%s' should either include a `serializer_class` attribute, "
"or override the `get_serializer_class()` method."
% self.__class__.__name__
)
return getattr(self, f"{self.action}_serializer_class") or self.serializer_class
然后将这个 mixin 添加到您的 ViewSet 中:
class MyModelViewSet(SelectSerializerMixin, ModelViewSet):
queryset = models.MyModel.objects.all()
serializer_class = serializers.SomeSerializer
retrieve_serializer_class = serializers.AnotherSerializer
list_serializer_class = serializers.OneMoreSerializer
但是,如果您需要一个带有一组动态字段的序列化程序(例如,您有一个处理程序,但您只需要 return 响应中的特定字段),您可以使用 Ykh 的回答中的方法。
我是 Django 的新手,找不到解决我的问题的方法。
问题是在使用不同视图的情况下,强制特定的序列化程序包含不同数量的字段。我想在第一个视图和第二个视图中使用 'id' 字段 - 'id' 和 'name' 字段。
这是我的 model.py
class Processing(models.Model):
id = models.AutoField(primary_key=True)
name = models.CharField()
description = models.CharField()
这是我的 serializer.py
class ProcessingSerializer(serializers.ModelSerializer):
id = serializers.ModelField(model_field=Processing()._meta.get_field('id'))
class Meta:
model = Processing
fields = ('id', 'name')
欢迎任何帮助。
class DynamicFieldsModelSerializer(ModelSerializer):
"""
A ModelSerializer that takes an additional `fields` and 'exclude' argument that
controls which fields should be displayed.
"""
def __init__(self, *args, **kwargs):
# Don't pass the 'fields' arg up to the superclass
fields = kwargs.pop('fields', None)
exclude = kwargs.pop('exclude', None)
# Instantiate the superclass normally
super(DynamicFieldsModelSerializer, 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)
if exclude is not None:
not_allowed = set(exclude)
for exclude_name in not_allowed:
self.fields.pop(exclude_name)
class UserCreateSerializer(DynamicFieldsModelSerializer):
class Meta:
model = User
fields = ('username', 'tel', 'email', 'password')
使用:
serializer = UserCreateSerializer(data=request.data, fields=('username', 'password', 'tel'))
或
serializer = UserCreateSerializer(data=request.data, fields=('username', 'password', 'email'))
当有人刚开始使用 DRF 时,一个常见的错误是试图让同一个序列化程序在阳光下做所有事情。当然,我自己也走上了这条路。
但是当您为不同的任务使用多个序列化程序时,生活会变得简单得多。您可以使用 get_serializer_class 方法轻松切换序列化器。这是手册中的一个示例,说明如何为管理员使用一个,为普通用户使用另一个
def get_serializer_class(self):
if self.request.user.is_staff:
return FullAccountSerializer
return BasicAccountSerializer
有时您希望对列表使用一个序列化器,而在提供详细信息时使用另一个序列化器。尝试这样的事情:
def get_serializer_class(self):
if self.action == 'retrieve':
return serializers.PlayerDetailSerializer
else :
return serializers.PlayerSerializer
这样生活就简单多了。
您还可以使用下一种方法:
class SelectSerializerMixin(object):
serializer_class = None
list_serializer_class = None
retrieve_serializer_class = None
update_serializer_class = None
partial_update_serializer_class = None
create_serializer_class = None
def get_serializer_class(self):
"""
Return the class to use for the serializer.
Defaults to using `self.serializer_class`.
"""
assert self.serializer_class is not None, (
"'%s' should either include a `serializer_class` attribute, "
"or override the `get_serializer_class()` method."
% self.__class__.__name__
)
return getattr(self, f"{self.action}_serializer_class") or self.serializer_class
然后将这个 mixin 添加到您的 ViewSet 中:
class MyModelViewSet(SelectSerializerMixin, ModelViewSet):
queryset = models.MyModel.objects.all()
serializer_class = serializers.SomeSerializer
retrieve_serializer_class = serializers.AnotherSerializer
list_serializer_class = serializers.OneMoreSerializer
但是,如果您需要一个带有一组动态字段的序列化程序(例如,您有一个处理程序,但您只需要 return 响应中的特定字段),您可以使用 Ykh 的回答中的方法。