Django rest framework - comment ajouter une valeur de champ statique pour un sérialiseur

Question

J'ai besoin d'ajouter un champ statique à mon sérialiseur. Il devrait toujours renvoyer la même valeur, peu importe l'objet passé. Actuellement, je l'ai implémenté de cette manière :

class QuestionSerializer(serializers.ModelSerializer):
    type = serializers.SerializerMethodField()

    @staticmethod
    def get_type(obj):
        return 'question'

    class Meta:
        model = Question
        fields = ('type',)

Mais y a-t-il un moyen plus simple de le faire, sans le SerializerMethodField ?

Answer 1

La seule alternative serait de substituer to_representation et d'ajouter la valeur ici :

def to_representation(self, obj):
    data = super().to_representation(obj)
    data['type'] = 'question'
    return data

Il ne s'agit toutefois pas d'une bien meilleure option.

Answer 2

Si vous ne vous souciez pas d'ajouter une ligne à votre modèle, il serait plus facile d'ajouter un champ statique à votre modèle.

class Question(models.Model):
    type = 'question'

class QuestionSerializer(serializers.ModelSerializer):

    class Meta:
        model = Question
        fields = ('type',)

Answer 3

Vous pouvez utiliser serializers.HiddenField

class QuestionSerializer(serializers.ModelSerializer):
type = serializers.HiddenField(default='question')

class Meta:
    model = Question
    fields = ('type',)

http://www.django-rest-framework.org/api-guide/fields/#hiddenfield

Answer 4

En utilisant un ReadOnlyField a fonctionné pour moi:

class QuestionSerializer(serializers.ModelSerializer):
type = serializers.ReadOnlyField(default='question')

class Meta:
    model = Question
    fields = ('type',)

https://www.django-rest-framework.org/api-guide/fields/#readonlyfield