115

如何将多对多字段序列化为列表，并通过 rest 框架返回它们？在下面的示例中，我尝试将帖子连同与之关联的标签列表一起返回。

模型.py

class post(models.Model):
    tag = models.ManyToManyField(Tag)
    text = models.CharField(max_length=100)

序列化程序.py

class PostSerializer(serializers.ModelSerializer):
    class Meta:
        model = Post
        fields = ("text", "tag"??)

视图.py

class PostViewSet(viewsets.ReadOnlyModelViewSet):
    queryset = Post.objects.all()
    serializer_class = PostSerializer
4

10 回答 10

144

您将需要一个TagSerializer，其class Meta拥有model = Tag。创建后TagSerializer，修改PostSerializerwithmany=True为一个ManyToManyField关系：

class PostSerializer(serializers.ModelSerializer):
    tag = TagSerializer(read_only=True, many=True)

    class Meta:
        model = Post
        fields = ('tag', 'text',)

答案适用于 DRF 3

于 2015-10-17T02:53:21.760 回答
35

这就是我所做的，假设一本书可以有多个作者，而作者可以有多个书： 在模型上：

class Author(models.Model):
    name = models.CharField(max_length=100, default="")
    last_name = models.IntegerField(default=0)

class Book(models.Model):
    authors = models.ManyToManyField(Author, related_name="book_list", blank=True)
    name = models.CharField(max_length=100, default="")
    published = models.BooleanField(default=True)

在序列化器上：

class BookSerializer(serializers.ModelSerializer):
    authors = serializers.PrimaryKeyRelatedField(queryset=Author.objects.all(), many=True)

    class Meta:
        model = Book
        fields = ('id', 'name', 'published', 'authors')


class AuthorSerializer(serializers.ModelSerializer):
    book_list = BookSerializer(many=True, read_only=True)

    class Meta:
        model = Author
        fields = ('id', 'name', 'last_name', 'book_list')
于 2018-07-04T15:45:22.490 回答
16

添加到@Brian 的答案 "tags": [{"name": "tag1"}] 可以通过这种方式简化为 "tags": ["tag1", "tag2",...] ：

class TagListingField(serializers.RelatedField):
 
     def to_representation(self, value):
         return value.name

class PostSerializer(serializers.ModelSerializer):
    tag = TagListingField(many=True, read_only=True)

    class Meta:
        ...

更多信息在这里：https ://www.django-rest-framework.org/api-guide/relations/#custom-relational-fields

于 2019-09-05T09:31:26.187 回答
8

默认ModelSerializer使用关系的主键。Meta depth但是，您可以使用以下属性轻松生成嵌套表示：

class PostSerializer(serializers.ModelSerializer):
    class Meta:
        model = Post
        fields = ("text", "tag")
        depth = 1

如文档中所述：

该depth选项应设置为整数值，指示在恢复为平面表示之前应遍历的关系深度。

于 2020-03-13T22:45:56.313 回答
4

姜戈 2.0

对于多对多领域，如果您想要特定的领域：

class QuestionSerializer(serializers.ModelSerializer):

    topics_list = serializers.SerializerMethodField()

    def get_topics_list(self, instance):
        names = []
        a = instance.topics.get_queryset()
        for i in a:
            names.append(i.desc)
        return names
    class Meta:
        model = Question
        fields = ('topics_list',)
于 2018-03-27T00:29:33.803 回答
4

这对我有用。

tag = TagSerializer(source="tag", read_only=True, many=True)
于 2016-08-09T12:36:57.597 回答
2

在init方法的序列化程序中，您可以将查询集传递给字段，rest_framework 验证该查询集上的 id

1）首先从 serializers.ModelSerializer 扩展您的序列化程序

class YourSerializer(serializers.ModelSerializer):

2）在元类中包含该字段

class YourSerializer(serializers.ModelSerializer):
  class Meta:
        fields = (..., 'your_field',)

3）在init方法中：

def __init__(self, *args, **kwargs):
    super(YourSerializer, self).__init__(*args, **kwargs)
    self.fields['your_field].queryset = <the queryset of your field>

您可以像往常一样使用过滤器或排除在任何参数下限制该字段的查询集。如果您想包含所有内容，只需使用 .objects.all()

于 2016-10-01T21:34:01.743 回答
1

模型.py

class Tag(models.Model):
    name = models.CharField(max_length=100)
    # ===============
    # ... rest of the fields ...

class Post(models.Model):
    tag = models.ManyToManyField(Tag)
    text = models.CharField(max_length=100)

序列化程序.py

class TagSerializer(serializers.ModelSerializer):
    class Meta:
        model = Tag
        fields = '__all__'


class PostSerializer(serializers.ModelSerializer):
    tags = TagSerializer(many=True, read_only=True)

    class Meta:
        model = Post
        fields = ("text", "tag")

视图.py

## FUNCTION BASED VIEW
def fbvPost_ListView(request):
    # list
    if request.method == "GET":
        posts = Post.objects.all()
        serializer = PostSerializer(instance=posts, many=True)
        return JsonResponse(serializer.data, safe=False)

    return JsonResponse({"success": False})

# ===========================================================

## CLASS BASED VIEW
class cbvPost_ListView(viewsets.ReadOnlyModelViewSet):
    queryset = Post.objects.all()
    serializer_class = PostSerializer

注意：Tag、Post 是两种模型，我们需要对它们进行序列化。这里，Post 模型依赖于 Tag 模型，所以这里我们明确提到它，[tags = TagSerializer(many=True, read_only=True)] 或其返回它的主要字段值。

详情在这里

于 2021-08-23T11:55:30.110 回答
0

嗨，我将展示多对多的更新和创建。上下文是事件可以有很多舞蹈，舞蹈可以有很多事件。

请求将如下所示。

 {
     "competition": 2,
     "title": "the title",
     "dances":[ {"id":1},{"id":2}],
     "description": "the desc"            
 }

创建函数将如下所示。 
def create(self, validated_data):
    try:
        dance_ids = []
        for dance in self.initial_data['dances']:
            if 'id' not in dance:
                raise serializers.ValidationError({'detail': 'key error'})
            dance_ids.append(dance['id'])

        new_event = models.Event.objects.create(**validated_data)
        
        if dance_ids:
            for dance_id in dance_ids:
                new_event.dances.add(dance_id)
        new_event.save()
        return new_event

    except Exception as e:
        raise serializers.ValidationError({'detail': e})

更新功能如下。 
def update(self, instance, validated_data):
    # Delete all records of genres.
    try:
        for current_genre in instance.dances.all():
            instance.dances.remove(current_genre)

        # Repopulate genres into instance.
        for dance in self.initial_data['dances']:
            if 'id' not in dance:
                raise serializers.ValidationError({'detail': 'key error'})
            dance_obj = models.Dance.objects.get(pk=dance['id'])
            instance.dances.add(dance_obj)

            event_updated = super().update(instance, validated_data)

        return event_updated
    except Exception as e:
        raise serializers.ValidationError({'detail': e})

如果您只想做“舞蹈”：[1,2]，只需对

for dance in self.initial_data['dances']:
        if 'id' not in dance:
            raise serializers.ValidationError({'detail': 'key error'})
        dance_ids.append(dance['id'])

部分。我希望这将能够帮助你们！:)

于 2021-08-16T18:38:54.777 回答
0

首先，Tag 也需要自己的序列化器

class TagSerializer(serializers.ModelSerializer):
    class Meta:
    model = Tag
    fields = '__all__'

然后在您的 PostSerializer 中，添加一行

class PostSerializer(serializers.ModelSerializer):
tag = TagSerializer(read_only=True, many=True).data
class Meta:
    model = Post
    fields = ("text", "tag")

这将使您在 Post 中的 Tag 字段是一个标签 ID 数组。如果你不放“.data”部分，它会放标签的所有属性，这在大多数情况下可能太多了

于 2021-12-15T02:36:19.003 回答