python - 何时将 http 方法映射到查看方法 django rest framework

Question

我见过这样实现的 View 集:

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

“如果需要，我们可以将这个 View 集绑定(bind)到两个单独的 View 中，如下所示:”

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

user_list 和user_detail 将连接到/使用在哪里？

更重要的是，在使用 View 集或通用 View 时，什么时候映射 http 方法？

因为我见过这样的示例，用于 View 集不使用映射并使用它们。使用示例我们可以谈谈它是如何工作的以及它是如何连接的吗？

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，您可以像这样在 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',
    ),
]

这是使用 ViewSet 的用户模型的只读实现。如果你想列出所有你可以请求的用户 /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，您可以像这样在 urls 文件中实现它:

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 装饰器来执行对 Model 有意义的操作，而不是模型的实例，例如，如果你想提供一些端点来下载关于你的模型的 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 文件，并且我在细节中添加了一个 details 方法，它将返回一些额外的信息，这些信息的检索成本可能很高，所以我们不希望它出现在正常的详细响应中。然后我们将得到一个 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 的其余框架文档。

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