Django REST框架--viewSets & Routers

教程6:ViewSets&Routers

REST框架包括一个处理的抽象ViewSets,它允许开发人员集中精力对API的状态和交互进行建模,并根据常规约定使URL构造自动处理。

ViewSet类是几乎同样的事情View类,但他们提供诸如操作read,或者update,而不是方法处理,如getput

一个ViewSet类只有在最后一刻被绑定到一组方法处理程序,当它被实例化成一组视图时,通常通过使用一个Router类来处理为你定义URL conf的复杂性。

重构使用ViewSets

我们来看看我们目前的观点,并将它们重构成视图集。

首先,让我们来重构我们UserListUserDetail意见纳入一个单一的UserViewSet。我们可以删除这两个视图,并用一个类替换它们:

from rest_framework import viewsets

class UserViewSet(viewsets.ReadOnlyModelViewSet):
    """
    This viewset automatically provides `list` and `detail` actions.
    """
    queryset = User.objects.all()
    serializer_class = UserSerializer

在这里,我们使用ReadOnlyModelViewSet该类来自动提供默认的“只读”操作。我们仍然按照我们使用常规视图的方式设置querysetserializer_class属性,但是我们不再需要向两个不同的类提供相同的信息。

接下来我们要更换SnippetListSnippetDetailSnippetHighlight视图类。我们可以删除三个视图,并再次替换为单个类。

from rest_framework.decorators import detail_route

class SnippetViewSet(viewsets.ModelViewSet):
    """
    This viewset automatically provides `list`, `create`, `retrieve`,
    `update` and `destroy` actions.

    Additionally we also provide an extra `highlight` action.
    """
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer
    permission_classes = (permissions.IsAuthenticatedOrReadOnly,
                          IsOwnerOrReadOnly,)

    @detail_route(renderer_classes=[renderers.StaticHTMLRenderer])
    def highlight(self, request, *args, **kwargs):
        snippet = self.get_object()
        return Response(snippet.highlighted)

    def perform_create(self, serializer):
        serializer.save(owner=self.request.user)

这一次,我们已经使用了ModelViewSet类来获取完整的默认读写操作。

请注意,我们还使用@detail_route装饰器创建一个名为的自定义操作highlight。此装饰器可用于添加不适合标准createupdatedelete样式的任何自定义端点。

默认情况下,使用@detail_route装饰器的自定义操作将响应GET请求。methods如果我们想要一个响应POST请求的动作,我们可以使用该参数。

默认情况下,自定义操作的URL取决于方法名称本身。如果要更改URL的构造方式,可以将url_path作为decorator的关键字参数。

明确地将ViewSets绑定到URL

当我们定义URLConf时,处理程序方法只能绑定到动作。看看发生什么事情,让我们首先从ViewSets中明确创建一组视图。

urls.py文件中,我们将我们的ViewSet类绑定到一组具体的视图中。

from snippets.views import SnippetViewSet, UserViewSet, api_root
from rest_framework import renderers

snippet_list = SnippetViewSet.as_view({
    ‘get‘: ‘list‘,
    ‘post‘: ‘create‘
})
snippet_detail = SnippetViewSet.as_view({
    ‘get‘: ‘retrieve‘,
    ‘put‘: ‘update‘,
    ‘patch‘: ‘partial_update‘,
    ‘delete‘: ‘destroy‘
})
snippet_highlight = SnippetViewSet.as_view({
    ‘get‘: ‘highlight‘
}, renderer_classes=[renderers.StaticHTMLRenderer])
user_list = UserViewSet.as_view({
    ‘get‘: ‘list‘
})
user_detail = UserViewSet.as_view({
    ‘get‘: ‘retrieve‘
})

请注意,我们如何ViewSet通过将http方法绑定到每个视图所需的操作,从每个类创建多个视图。

现在我们将资源绑定到具体的视图中,我们可以像往常一样使用URL conf注册视图。

urlpatterns = format_suffix_patterns([
    url(r‘^$‘, api_root),
    url(r‘^snippets/$‘, snippet_list, name=‘snippet-list‘),
    url(r‘^snippets/(?P<pk>[0-9]+)/$‘, snippet_detail, name=‘snippet-detail‘),
    url(r‘^snippets/(?P<pk>[0-9]+)/highlight/$‘, snippet_highlight, name=‘snippet-highlight‘),
    url(r‘^users/$‘, user_list, name=‘user-list‘),
    url(r‘^users/(?P<pk>[0-9]+)/$‘, user_detail, name=‘user-detail‘)
])

使用路由器

因为我们使用ViewSet类而不是View类,我们实际上不需要设计自己的URL。将资源连接到视图和网址的约定可以使用Router类自动处理。我们需要做的就是使用路由器注册相应的视图集,然后让它执行其余操作。

这是我们的重新连接的urls.py文件。

from django.conf.urls import url, include
from snippets import views
from rest_framework.routers import DefaultRouter

# Create a router and register our viewsets with it.
router = DefaultRouter()
router.register(r‘snippets‘, views.SnippetViewSet)
router.register(r‘users‘, views.UserViewSet)

# The API URLs are now determined automatically by the router.
# Additionally, we include the login URLs for the browsable API.
urlpatterns = [
    url(r‘^‘, include(router.urls)),
    url(r‘^api-auth/‘, include(‘rest_framework.urls‘, namespace=‘rest_framework‘))
]

与路由器注册视图与提供urlpattern类似。我们包含两个参数 - 视图的URL前缀和视图本身。

DefaultRouter我们使用的类也会自动为我们创建API根视图,因此我们现在可以api_root从我们的views模块中删除该方法。

视图vs视图之间的权衡

使用视图可以是一个非常有用的抽象。它有助于确保您的API中的URL约定是一致的,最大限度地减少您需要编写的代码量,并允许您专注于API提供的交互和表示,而不是URL conf的具体内容。

这并不意味着它总是正确的做法。在使用基于类的视图而不是基于函数的视图时,需要考虑一组类似的权衡。使用viewsets比单独创建视图不太明确。

接下来我们将介绍如何添加API模式,并使用客户端库或命令行工具与我们的API进行交互。

时间: 2024-10-22 16:05:03

Django REST框架--viewSets & Routers的相关文章

django rest framework ViewSets &amp; Routers

Using viewsets views.py from rest_framework import viewsets from rest_framework import mixins from rest_framework.pagination import PageNumberPagination class MyPagination(PageNumberPagination): """分页""" page_size = 10 page_s

测开大佬告诉你:如何5分钟快速创建restful风格的API接口-使用django restframework框架

一.思考?? 1.创建API接口难吗? 软件测试工程师: 只测过API接口, 从没创建过 应该需要掌握一门后端开发语言和后端开发框架吧!? 脑容量有限,想想就可怕 2.如何创建API接口呢? 使用Django restframework能快速创建符合restful风格的API接口 通过Django restframework框架提供的序列化器.视图集可轻轻松松实现 简单高效,学习成本低 二.搭建项目工程???? 1.创建项目 打开pycharm 创建项目 使用豆瓣源安装Django Django

Tutorial 6: ViewSets &amp; Routers

转载自:http://www.django-rest-framework.org/tutorial/6-viewsets-and-routers/ Tutorial 6: ViewSets & Routers REST framework includes an abstraction for dealing with ViewSets, that allows the developer to concentrate on modeling the state and interactions

记Angular与Django REST框架的一次合作(2):前端组件化——Angular

注:这是这个系列的第二部分,主要集中在Angular的使用方面.之前使用过AngularJS(Angular 1.x),混在Django的模板中使用,这些页面一般完全是结果展示页.在有Django表单输入的页面中,就很难将两者很好的结合起来.自己在学习新版的Angular时,跟了2遍官方网站的“英雄指南”教程.第1次完全是照搬,熟悉了一下基本概念:第2次自己做了一些修改,写了一个图片分享系统(只有一个雏形,还不是特别完善). 推荐IDE:Visual Studio Code 代码: github

python Django Wbe框架教程

python  Django Wbe框架教程 一.简介 Django 中提供了开发网站经常用到的模块,常见的代码都为你写好了,通过减少重复的代码,Django 使你能够专注于 web 应用上有 趣的关键性的东西.为了达到这个目标,Django 提供了通用Web开发模式的高度抽象,提供了频繁进行的编程作业的快速解决方法,以及为“如何解决问题”提供了清晰明了的约定.Django的理念是DRY(Don't Repeat Yourself)来鼓励快速开发! 让我们一览 Django 全貌 urls.py

Django—— 缓存框架

译者注:1.无用的,吹嘘的说辞不翻译:2.意译,很多地方不准确. 动态网站最为重要的一点就是好,网页是动态的.每一次用户请求页面,网站就要进行各种计算——从数据库查询,到render模板,到各种逻辑运算——生成页面所需的.这个过程是异常消耗资源的,远远比从硬盘读取一个文件然后显示出来的代价高昂. 对于大多数中小网站来说,这也许不是问题,因为他们的访问量不大,而对于大型网站而言,必须尽量减少不必要的服务器资源开支. 因此,有了缓存技术. 缓存就是把一些需要消耗很多资源的计算结果保存下来,当下次需要

Django 六大框架之 Models

  先睹为快 from django.db import models class Person(models.Model):     first_name = models.CharField(max_length=30) last_name = models.CharField(max_length=30)   核心要点 每一个model 是 django.db.models.Model 的子类       --> 数据库表 每一个model属性 是 django.db.models.Fil

Linux(CentOS7)系统中部署Django web框架

1. 概述 部署django和vue架在逻辑上可以分为web层与数据库层:web前端通过实现了WSGI协议的模块对python代码进行解析,而python代码中则通过特定于数据库的操作接口对数据库进行读取与写入. Django自身内置了轻量级的web服务器与sqlite数据库,可以用于简单的代码测试,并支持Apache httpd与Nginx作为web前端,以及PostgreSQL/MySQL/Oracle等数据库作为后端存储,用于实际的生产环境. 本文分别以MySQL + Apache htt

Django REST框架

安装 安装使用pip,包括您想要的任何可选包... pip install djangorestframework pip install markdown           # Markdown support for the browsable API. pip install django-filter        #  Filtering  support 添加 'rest_framework'  到你的 INSTALLED_APPS设置 INSTALLED_APPS = ( 're