Django REST Framework——序列化多对多表关系答案

【问题标题】：Django REST Framework -- Serializing many-to-many table relationshipsDjango REST Framework——序列化多对多表关系
【发布时间】：2018-05-22 13:14:13
【问题描述】：

我正在为一个网站创建一个 API，我有一个带有 Books 的表格，另一个带有 Hashtags（基本上是一个主题标签的目录，例如 "#traveling" ）和一个用于建立多对多的中间表书籍和标签之间的关系。我的模型是：

# models.py
class Books(models.Model):
    id_books = models.AutoField(primary_key=True)
    title = models.CharField(max_length=150)

class Hashtags(models.Model):
    id_hashtags = models.AutoField(primary_key=True)
    hashtag = models.CharField(max_length=150)

class Books_Hashtags(models.Model):
    id_books_hashtags = models.AutoField(primary_key=True)
    id_books = models.ForeignKey(Books, on_delete=models.CASCADE)
    id_hashtags = models.ForeignKey(Hashtags, on_delete=models.CASCADE)
    class Meta:
        unique_together = ("id_books", "id_hashtags")

我想要一个提供如下输出的 API：

[
    {
        "id_books": 1,
        "title": "The Hobbit",
        "hashtags": [
            {
                "id_hashtags": 1,
                "hashtag": "fantasy"
            },
            {
                "id_hashtags": 2,
                "hashtag": "fiction"
            },
            {
                "id_hashtags": 3,
                "hashtag": "middle earth"
            },
        ]
    }
]

为此，我按照我在网上找到的一些示例，使用 DRF 对上述模型进行了序列化：

#serializers.py
from rest_framework import serializers
from app.models import Books, Books_Hashtags, Hashtags

class HashtagsSerializer(serializers.ModelSerializer):
    hashtags = serializers.CharField()
    class Meta:
        model = Hashtags
        fields = ('hashtag',)

class Books_HashtagsSerializer(serializers.ModelSerializer):
    id_hashtag = HashtagsSerializer(many=True, read_only=True)
    class Meta:
        model = Books_Hashtags
        fields = ('id_hashtags',)

class BooksSerializer(serializers.ModelSerializer):
    id_books = serializers.IntegerField()
    id_books_hashtags = Books_HashtagsSerializer(many=True, read_only=True)
    title = serializers.CharField()

    class Meta:
        model = Books
        fields = ('id_books', 'title', 'id_books_hashtags',)

我的观点是这样的：

#views.py
from ntgBackend.models import Books
from rest_framework import viewsets
from api.serializers import BooksSerializer

class BooksViewSet(viewsets.ModelViewSet):
    serializer_class = BooksSerializer
    queryset = Books.objects.all()

到目前为止，我已经设法从 API 获得以下输出：

[
    {
        "id_books": 1,
        "title": "The Hobbit",
    }
]

但没有关于主题标签的信息，我知道它们存在于数据库中。我将 DRF 3.8.2 与 MySQL DB 和 Django 2.0.2 一起使用。请帮忙！

【问题讨论】：

标签： python django django-rest-framework

【解决方案1】：

我遇到了同样的问题，并通过一些研究得出以下结论：

在 models.py 中，仅修改您的 Book 模型以包含带有 Hashtags 的 ManyToManyField，使用 Books_Hashtagas 作为中间表。另外请务必在第一本书之前声明您的 Hashtag 模型以供参考

# models.py
class Books(models.Model):
    id_books = models.AutoField(primary_key=True)
    title = models.CharField(max_length=150)
    hashtags = models.ManyToManyField(Hashtags, related_name='hashTg', through="Books_Hashtags"

确保在您的序列化程序文件中添加 depth = 1 以获得您需要的内容，否则您只会获得主题标签 ID（这仅适用于 ListAPI）

#serializers.py
class BooksSerializer(serializers.ModelSerializer):
    class Meta:
        model = Books
        #In case you want to filter out some fields:
        #fields = ('field_A','field_B' )
        fields = '__all__'
        depth = 1

在视图中我使用泛型，因为它们解决了我的大部分需求：

#views.py
from ntgBackend.models import Books
from rest_framework import generics
from api.serializers import BooksSerializer

class BooksViewSet(generics.ListCreateAPIView):
    serializer_class = BooksSerializer
    queryset = Books.objects.all()

我对此很陌生，希望对您有所帮助。除了Django（2.0.4）之外，我使用的版本几乎与您相同。

祝你好运

【讨论】：