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

Question

我见过像这样实现的viewsets:

我们可以在django rest框架文档中扩展这行代码:

"如果需要,我们可以将这个视图集绑定到两个单独的视图中,如下所示:"

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的User模型的只读实现.如果要列出可以请求的所有用户/users/,并且如果要获取id为1的用户,则可以请求/users/1/.

您应该了解的是,有些操作会对您的模型起作用,例如列出用户或创建新用户,以及作用于模型实例的操作.例如,如果要检索,更新或删除User实例,则需要在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上注册自定义方法.

对于休息框架3.8及以上@detail_route,@list_route已被弃用,有利于@action装饰器替换@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框架文档.

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