Champ supplémentaire lors de la sérialisation de django repos cadre

Je suis un newbie de django rest framework, et ont créé un exemple de Employee modèle.

Mon models.py:

class Employees(models.Model):
    created = models.DateTimeField(auto_now_add=True)
    first_name = models.CharField(max_length=100)
    last_name = models.CharField(max_length=100)

Mon serializers.py:

class EmployeeSerializer(serializers.Serializer):
    class Meta:
        model = Employees
        fields = ('first_name','last_name')

Cela fonctionne bien mais je veux un champ supplémentaire full_name, qui sera first_name + last_name.

Comment définir ce nouveau champ full_name dans mon serializers.py?

InformationsquelleAutor user1050619 | 2014-03-27
  1. 73

    Je vois deux façons ici (je préfère la première façon puisque vous pouvez la réutiliser dans d'autres parties de l'application):

    ajouter une propriété calculée à votre modèle et l'ajouter à votre sérialiseur
    en utilisant un readonly terrain avec source=

    # models.py
class Employees(models.Model):
    created = models.DateTimeField(auto_now_add=True)
    first_name = models.CharField(max_length=100)
    last_name = models.CharField(max_length=100)

    @property
    def full_name(self):
        return self.first_name + self.last_name

#serializes.py
class EmployeeSerializer(serializers.ModelSerializer):
    full_name = serializers.Field(source='full_name')

    class Meta:
        model = Employees
        fields = ('first_name','last_name', 'full_name')

    en utilisant SerializerMethodField
    (votre modèle inchangé)

    class EmployeeSerializer(serializers.ModelSerializer):
    full_name = serializers.SerializerMethodField('get_full_name')

    def get_full_name(self, obj):
        return obj.first_name + obj.last_name

    class Meta:
        model = Employees
        fields = ('first_name','last_name', 'full_name')
    • Pour moi, à l'aide de serializers.Field a donné une erreur. serializers.ReadOnlyField fonctionne si to_representation n'est pas défini et que la vue est en lecture seule.
    • J'ai juste eu le même problème (je ne suis pas la sérialisation d'un Django modèle, mais un autre de la plaine de la classe), et après avoir cogné la tête sur un moment j'ai trouvé que cela fonctionne bien si vous utilisez full_name = serializers.ReadOnlyField(), c'est à dire de jeter la source paramètre tout à fait. Comme le documentation dit à propos de la source paramètre: la valeur par défaut est le nom du champ. Sna il fonctionne même si c'est une méthode (ou une propriété)
    • Pour moi (django 1.11.13) il n'est pas nécessaire de déclarer le terrain dans le processus, il suffit de déclarer dans le Modèle et la liste dans la Méta.champs.
    InformationsquelleAutor Denis Cornehl
  2. 4

    À condition que le Employee est un identifiant de connexion, puis la plupart d'entre nous utiliserons django.auth.User, je vais partager la façon dont Employee peut être mis en œuvre comme un autre Profile (extension de django Utilisateur). Aussi, avec l'ajout de full_name.read_only, first_name.write_only, et last_name.write_only

    # models.py
class Employee(models.Model):
    """User Profile Model"""
    user = models.OneToOneField('auth.User')

# serializers.py
class EmployeeSerializer(serializers.HyperlinkedModelSerializer):
    username = serializers.CharField(source='user.username')
    email = serializers.EmailField(source='user.email')

    first_name = serializers.CharField(
            source='user.first_name', write_only=True)
    last_name = serializers.CharField(
            source='user.last_name', write_only=True)
    name = serializers.CharField(
            source='user.get_full_name', read_only=True)


    class Meta:
        model = Employee
        fields = (
            'url', 'username', 'email',
            'first_name', 'last_name', 'name')
        depth = 1
    InformationsquelleAutor Yeo
  3. 3

    SerializerMethodField fonctionne bien, et nous pouvons également stocker des données dans sérialiseur de l'objet et de la méthode let get_field_name l'utiliser.

    Exemple:

    class MySerializer(serializers.ModelSerializer):
    statistic = serializers.SerializerMethodField()

    def __init__(self, instance=None, data=serializers.empty, statistic=None, **kwargs):
        super(MySerializer, self).__init__(instance=instance, data=data, **kwargs)
        self.statistic = statistic

    def get_statistic(self, obj):
        if self.statistic is None:
            return serializers.empty
        return self.statistic.get(obj.id, {})
    InformationsquelleAutor Craynic Cai