如何使用 Django REST 框架 ModelViewSet 实现 HATEOAS 样式的链接？

Question

我有这个产品型号

import uuid
from django.db import models


class Product(models.Model):
    """Product in the store."""

    title = models.CharField(max_length=120)
    description = models.TextField(blank=True)
    price = models.DecimalField(decimal_places=2, max_digits=10)
    inventory = models.IntegerField(default=0)
    uuid = models.UUIDField(default=uuid.uuid4, editable=False)

    def __str__(self):
        return f'{self.title}'

我为它定义了一个序列化器

from rest_framework import serializers
from .models import Product


class ProductSerializer(serializers.ModelSerializer):
    class Meta:
        model = Product
        fields = ['title', 'description', 'price', 'inventory', 'uuid']

这是我的观点

from rest_framework import viewsets
from .serializers import ProductSerializer

from .models import Product


class ProductViewSet(viewsets.ReadOnlyModelViewSet):
    queryset = Product.objects.all()
    serializer_class = ProductSerializer
    lookup_field = 'uuid'

要开始这个问题，请记住此视图路由到/store/products/。 现在，例如，我可以执行 GET http://localhost/store/products/ 并返回

[
    {
        "title": "Computer",
        "description": "",
        "price": "50.00",
        "inventory": 10,
        "uuid": "2d849f18-7dea-42b9-9dac-2ea8a17444c2"
    }
]

但我希望它返回类似的东西

[
    {
        "href": "http://localhost/store/products/2d849f18-7dea-42b9-9dac-2ea8a17444c2"
    }
]

然后让http://localhost/store/products/2d849f18-7dea-42b9-9dac-2ea8a17444c2返回

{
    "title": "Computer",
    "description": "",
    "price": "50.00",
    "inventory": 10,
    "uuid": "2d849f18-7dea-42b9-9dac-2ea8a17444c2"
}

就像它已经做到的那样。这是否可以使用内置序列化，或者我如何定义一个这样做的？我玩过list_serializer_class 属性，但我什么都做不了。

Answer 1

超链接的序列化程序可以返回指向另一个视图或同一视图集的另一部分的属性：

序列化器：

from rest_framework import serializers

class ProductListSerializer(serializers.ModelSerializer):
    href = serializers.HyperlinkedIdentityField(view_name='<app_name>:product-detail', lookup_field='uuid')

    class Meta:
        model = Product
        fields = ['href']

class ProductDetailSerializer(serializers.ModelSerializer):
    class Meta:
        model = Product
        fields = ['title', 'description', 'price', 'inventory', 'uuid']

网址：

from rest_framework import routers

app_name ='<app_name>'

router = routers.DefaultRouter()
router.register(r'products', ProductViewSet, basename='product')
urlpatterns = router.urls

视图集：

from rest_framework.response import Response
from django.shortcuts import get_object_or_404

class ProductViewSet(viewsets.ReadOnlyModelViewSet):
    queryset = Product.objects.all()
    lookup_field = 'uuid'

    def list(self, request, **kwargs):
        serializer = ProductListSerializer(self.get_queryset(), many=True, context={'request': request})
        return Response(serializer.data)

    def retrieve(self, request, uuid=None, *args, **kwargs):
        record = get_object_or_404(self.get_queryset(), uuid=uuid)
        serializer = ProductDetailSerializer(record)
        return Response(serializer.data)

编辑：更新为使用 uuid，而不是 pk，如您的示例所示

Answer 2

对于 URL，您可以有 4 个选项：

1- 在您的模型中使用 SlugField 并使用 uuid 预填充它。你可以在Auto Populate Slug field django阅读它

2- 在您的序列化程序中使用 SerializerMethodField 并在其中创建 URL：

class ProductListSerializer(serializers.ModelSerializer):
    url = serializers.SerializerMethodField()
    ...
    def get_url(self, obj):
        return self.request.build_absolute_url() + obj.uuid

您可以在https://www.django-rest-framework.org/api-guide/fields/#serializermethodfield 中阅读有关SerializerMethodField 的信息

3- 在您的模型中覆盖 get_absolute_url 并在您的 SerializerMethodField 中使用它。阅读https://docs.djangoproject.com/en/3.2/ref/models/instances/#get-absolute-url

4- 在序列化程序中使用HyperlinkedIdentityField。 https://www.django-rest-framework.org/api-guide/relations/#hyperlinkedidentityfield中的文档

---

对于详细信息和列表部分，请使用 2 个单独的序列化程序，例如：

class ProductDetailSerializer(serializers.ModelSerializer):
    class Meta:
        model = Product
        fields = ['title', 'description', 'price', 'inventory', 'uuid']

class ProductListSerializer(serializers.Serializer):
    url = serializers.SerializerMethodField()
    
    def get_url(self, obj):
        ...

然后，在你的views.py 覆盖get_serializer_class：

class ProductViewSet(viewsets.ReadOnlyModelViewSet):
    ...
    def get_serializer_class():
        if self.action == 'retrieve':
            return ProductDetailSerializer
        if self.action == 'list':
            return ProductListSerializer