Django Rest Framework - Comment ajouter un champ personnalisé dans ModelSerializer

J'ai créé un ModelSerializeret je souhaite ajouter un champ personnalisé qui ne fait pas partie de mon modèle.

J'ai trouvé une description pour ajouter des champs supplémentaires ici et j'ai essayé ce qui suit:

customField = CharField(source='my_field')

Lorsque j'ajoute ce champ et que j'appelle ma validate()fonction, ce champ ne fait pas partie du attrdict. attrcontient tous les champs de modèle spécifiés à l'exception des champs supplémentaires. Je ne peux donc pas accéder à ce champ dans ma validation écrasée, n'est-ce pas?

Lorsque j'ajoute ce champ à la liste des champs comme ceci:

class Meta:
    model = Account
    fields = ('myfield1', 'myfield2', 'customField')

alors j'obtiens une erreur car customFieldne fait pas partie de mon modèle - ce qui est correct parce que je veux l'ajouter juste pour ce sérialiseur.

Existe-t-il un moyen d'ajouter un champ personnalisé?

Vous faites la bonne chose, sauf que CharField(et les autres champs tapés) sont pour les champs inscriptibles.

Dans ce cas, vous voulez juste un champ en lecture seule simple, alors utilisez simplement:

customField = Field(source='get_absolute_url')

En fait, il existe une solution sans toucher du tout au modèle. Vous pouvez utiliser SerializerMethodFieldce qui vous permet de connecter n'importe quelle méthode à votre sérialiseur.

class FooSerializer(ModelSerializer):
    foo = serializers.SerializerMethodField()

    def get_foo(self, obj):
        return "Foo id: %i" % obj.pk

... pour plus de clarté, si vous avez une méthode modèle définie de la manière suivante:

class MyModel(models.Model):
    ...

    def model_method(self):
        return "some_calculated_result"

Vous pouvez ajouter le résultat de l'appel de ladite méthode à votre sérialiseur comme ceci:

class MyModelSerializer(serializers.ModelSerializer):
    model_method_field = serializers.CharField(source='model_method')

ps Puisque le champ personnalisé n'est pas vraiment un champ dans votre modèle, vous voudrez généralement le rendre en lecture seule, comme ceci:

class Meta:
    model = MyModel
    read_only_fields = (
        'model_method_field',
        )

voici la réponse à votre question. vous devez ajouter à votre compte modèle:

@property
def my_field(self):
    return None

maintenant vous pouvez utiliser:

customField = CharField(source='my_field')

source: https://stackoverflow.com/a/18396622/3220916

Pour montrer self.author.full_name, j'ai eu une erreur avec Field. Cela a fonctionné avec ReadOnlyField:

class CommentSerializer(serializers.HyperlinkedModelSerializer):
    author_name = ReadOnlyField(source="author.full_name")
    class Meta:
        model = Comment
        fields = ('url', 'content', 'author_name', 'author')

Avec la dernière version de Django Rest Framework, vous devez créer une méthode dans votre modèle avec le nom du champ que vous souhaitez ajouter.

class Foo(models.Model):
    . . .
    def foo(self):
        return 'stuff'
    . . .

class FooSerializer(ModelSerializer):
    foo = serializers.ReadOnlyField()

    class Meta:
        model = Foo
        fields = ('foo',)

Je cherchais une solution pour ajouter un champ personnalisé inscriptible à un sérialiseur de modèle. J'ai trouvé celui-ci, qui n'a pas été couvert dans les réponses à cette question.

Il semble que vous ayez effectivement besoin d'écrire votre propre sérialiseur simple.

class PassThroughSerializer(serializers.Field):
    def to_representation(self, instance):
        # This function is for the direction: Instance -> Dict
        # If you only need this, use a ReadOnlyField, or SerializerField
        return None

    def to_internal_value(self, data):
        # This function is for the direction: Dict -> Instance
        # Here you can manipulate the data if you need to.
        return data

Vous pouvez maintenant utiliser ce sérialiseur pour ajouter des champs personnalisés à un ModelSerializer

class MyModelSerializer(serializers.ModelSerializer)
    my_custom_field = PassThroughSerializer()

    def create(self, validated_data):
        # now the key 'my_custom_field' is available in validated_data
        ...
        return instance

Cela fonctionne également si le modèle a MyModelen fait une propriété appelée my_custom_fieldmais que vous souhaitez ignorer ses validateurs.

Après avoir lu toutes les réponses ici, ma conclusion est qu'il est impossible de faire cela proprement. Vous devez jouer sale et faire quelque chose de hadk, comme créer un champ write_only, puis remplacer les méthodes validateet to_representation. C'est ce qui a fonctionné pour moi:

class FooSerializer(ModelSerializer):

    foo = CharField(write_only=True)

    class Meta:
        model = Foo
        fields = ["foo", ...]

    def validate(self, data):
        foo = data.pop("foo", None)
        # Do what you want with your value
        return super().validate(data)

    def to_representation(self, instance):
        data = super().to_representation(instance)
        data["foo"] = whatever_you_want
        return data