Question

我见过像这样实现的视图集：

我们可以在django rest frameworks docs中扩展这行代码：

“如果需要，我们可以将此视图集绑定到两个单独的视图中，如下所示：”

user_list = UserViewSet.as_view({'get': 'list'})
user_detail = UserViewSet.as_view({'get': 'retrieve'})

将user_list和user_detail连接到/使用的位置？

更多的是，您何时在使用viewsets或通用视图时映射http方法？

因为我看过不使用映射并使用它们的视图集这样的例子。使用示例我们可以谈谈它是如何工作的以及它是如何连接的？

task_list = TaskViewSet.as_view({
    'get': 'list',
    'post': 'create'
})

task_detail = TaskViewSet.as_view({
    'get': 'retrieve',
    'put': 'update',
    'patch': 'partial_update',
    'delete': 'destroy'
})

task_router = DefaultRouter()
task_router.register(r'tasks', TaskViewSet)

还有这个：

@detail_route(methods=['post'])
    def set_password(self, request, pk=None):

如果我们有路径装饰器，为什么我们在url映射？他们之间有什么区别？

Answer 1

关于第一个问题，关于连接UserViewSet，您可以使用url文件中的那些：

urlpatterns = [
    url(
        r'^users/$',
        UserViewSet.as_view({'get': 'list'}),
        name='user-list',
    ),
    url(
        r'^users/(?P<pk>\d+)/$',
        UserViewSet.as_view({'get': 'retrieve'}),
        name='user-detail',
    ),
]

这是使用ViewSet的用户模型的只读实现。如果您要列出可以请求/users/的所有用户，并且您希望获得ID为1的用户，则可以请求/users/1/。

您应该了解的是，有些操作会对您的模型产生影响，例如列出用户或创建新用户，以及作用于模型实例的操作< / strong>即可。例如，如果要检索，更新或删除用户实例，则需要在URL中包含用户主键，以便您可以获取该用户。

您的TaskViewSet不是只读的，所以让我们来看看该类应该是什么样的。

class TaskViewSet(ModelViewSet): queryset = Task serializer_class = TaskSerializer lookup_field = 'pk' # This is the default lookup_url_kwarg = 'pk' # This is the default

这是一个简单的通用ModelViewSet，您可以在url文件中实现，如下所示：

urlpatterns = [ url( r'^tasks/$', TaskViewSet.as_view({'get': 'list', 'post': 'create'}), name='task-list', ), url( r'^tasks/(?P<pk>\d+)/$', TaskViewSet.as_view({'get': 'retrieve', 'put': 'update', 'patch': 'partial_update', 'delete': 'destroy'}), name='task-detail', ), ]

现在，您可以对模型执行任何操作，您可以列出，创建，检索，更新和删除对象。您将看到使用ModelViewSet在这里形成一些模式，这就是路由器的便利性突出的地方。 Django Rest Frameworks路由器实现基本上是通过获取路径和ViewSet然后构建URL来实现的。

在这个例子中，我们使用SimpleRouter生成我们的url模式。

router = SimpleRouter() router.register('users', UserViewSet) # UserViewSet is ReadOnlyModelViewSet router.register('tasks', TaskViewSet) # TaskViewSet is ModelViewSet urlpatterns = [] + router.urls

哪会产生：

urlpatterns = [ url( r'^users/$', UserViewSet.as_view({'get': 'list'}), name='user-list', ), url( r'^users/(?P<pk>\d+)/$', UserViewSet.as_view({'get': 'retrieve'}), name='user-detail', ), url( r'^tasks/$', TaskViewSet.as_view({'get': 'list', 'post': 'create'}), name='task-list', ), url( r'^tasks/(?P<pk>\d+)/$', TaskViewSet.as_view({'get': 'retrieve', 'put': 'update', 'patch': 'partial_update', 'delete': 'destroy'}), name='task-detail', ), ]

我希望到目前为止这是有道理的，你可以看到如何使用这些类来减少你需要编写的代码量。

现在，我将解释@detail_route和@list_route装饰器正在做什么。这些装饰器帮助Router类在ViewSet上注册自定义方法。

For rest framework 3.8 and above @detail_route and @list_route have been deprecated in favour of the @action decorator将@detail_route(...)替换为@action(detail=True, ...)。将@list_route(...)使用替换为@action(detail=False, ...)。

您应该使用@list_route装饰器来执行有意义的操作，以便在模型上调用，而不是模型的实例，如果您想要提供此示例，则可能是这样的示例某些端点将您的模型报告下载为csv。您应该使用@detail_route装饰器来处理模型实例的操作。我将从之前扩展TaskViewSet示例。

class TaskViewSet(ModelViewSet): queryset = Task serializer_class = TaskSerializer lookup_field = 'pk' # This is the default lookup_url_kwarg = 'pk' # This is the default @list_route(methods=['get']) def download(self, request, *args, **kwargs): """Download queryset as xlsx""" qs = self.get_queryset() return queryset_to_excel(qs) # simple example @detail_route(methods=['get']) def details(self, request, *args, **kwargs): """Return intricate details of Task""" object = self.get_object() return object.get_intricate_task_details()

如果我们将这个TaskViewSet与路由器一起使用：

router = SimpleRouter() router.register('tasks', TaskViewSet) urlpatterns = [] + router.urls

我已经在列表中添加了下载方法，将查询集下载为Excel文件，并且我已经为详细信息添加了详细信息方法，这将返回一些可能很昂贵的额外信息。检索，所以我们不希望它在正常的细节响应上。然后我们将得到一个url配置，如：

urlpatterns = [ url( r'^tasks/$', TaskViewSet.as_view({'get': 'list', 'post': 'create'}), name='task-list', ), url( r'^tasks/download/$', TaskViewSet.as_view({'get': 'download'}), name='task-download', ), url( r'^tasks/(?P<pk>\d+)/$', TaskViewSet.as_view({'get': 'retrieve', 'put': 'update', 'patch': 'partial_update', 'delete': 'destroy'}), name='task-detail', ), url( r'^tasks/(?P<pk>\d+)/details/$', TaskViewSet.as_view({'get': 'detail'}), name='task-details', ), ]

路由器现在为TaskViewSet上定义的自定义方法生成了其他路由。

我建议阅读ViewSet和SimpleRouter上的rest frameworks文档。

http://www.django-rest-framework.org/api-guide/viewsets/#modelviewset
http://www.django-rest-framework.org/api-guide/routers/#simplerouter

何时映射http方法以查看方法django rest framework

1 个答案: