Rest-framework专栏讲解(八)：ViewSet: 带你轻松编写RESTful API

2023-11-20 18:53:04

Rest-framework 专栏讲解：深入剖析 ViewSet

引言

在编写 RESTful API 时，Django REST framework 的 ViewSet 是一个强有力的工具。它简化了数据模型和 URL 的映射，并提供了处理不同 HTTP 请求的方法。让我们深入了解 ViewSet，探索其用法和优势。

使用 ViewSet

创建 ViewSet 类是使用 ViewSet 的第一步。根据您是否需要处理模型数据，您可以扩展 ViewSet 或 ModelViewSet。ModelViewSet 专用于处理模型数据。

from rest_framework import ViewSet, ModelViewSet, serializers

class UserViewSet(ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer

这里，UserViewSet 从 ModelViewSet 继承，指定了要处理的模型（User）和用于序列化和反序列化的类（UserSerializer）。

身份验证

ViewSet 的 authentication_classes 属性允许您控制访问策略。通过指定身份验证类，您可以确保只有授权用户才能访问该 ViewSet。

from rest_framework import ViewSet, ModelViewSet, serializers, authentication

class UserViewSet(ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    authentication_classes = [authentication.TokenAuthentication]

在上面的示例中，UserViewSet 使用了 TokenAuthentication 类进行身份验证。

数据查询

ViewSet 提供了 get_object 和 get_queryset 方法来控制数据查询。get_object 获取单个对象，而 get_queryset 获取对象列表。

from rest_framework import ViewSet, ModelViewSet, serializers

class UserViewSet(ModelViewSet):
    def get_object(self):
        return User.objects.get(pk=self.kwargs['pk'])

    def get_queryset(self):
        return User.objects.all()