视图集(ViewSets)

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

ViewSet 类与 View 类几乎相同,不同之处在于它们提供诸如 readupdate 之类的操作,而不是 getput 等方法处理程序。

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




使用 ViewSets 重构

我们看一下目前的视图,把它们重构成视图集。

首先让我们将 UserListUserDetail 视图重构为一个 UserViewSet。我们可以删除这两个视图,并用一个类替换它们:

# apis.py

from django.contrib.auth.models import User
from myapp.serializers import UserSerializer
from rest_framework import viewsets # 视图集


class UserViewSet(viewsets.ReadOnlyModelViewSet):
    """
    此视图自动提供`list`和`detail`操作。
    (这里的文字会显示在 API 页面上)
    """
    queryset = User.objects.all()
    serializer_class = UserSerializer

接下来类似的替换掉 BookListBookDetail

# apis.py

from rest_framework import viewsets # 视图集
from myapp.models import Book
from myapp.serializers import BookSerializer
from rest_framework import permissions # 权限模块
from myapp.permissions import IsOwnerOrReadOnly # 自定义权限


class BookViewSet(viewsets.ModelViewSet):
    """
    此视图自动提供`list`,`create`,`retrieve`,`update`和`destroy`操作。
    """
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    permission_classes = (permissions.IsAuthenticatedOrReadOnly,
                          IsOwnerOrReadOnly,)

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




将 ViewSets 绑定到 URL

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

# urls.py

from myapp.apis import BookViewSet, UserViewSet, api_root

book_list = BookViewSet.as_view({
    'get': 'list',
    'post': 'create'
})

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

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

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

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

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

# urls.py

urlpatterns = [
    url(r'^admin/', admin.site.urls),

    # API 根目录
    url(r'^api/$', api_root),

    # 所有 user 的 API
    url(r'^api/users/$', user_list, name='user-list'),
    # 单个 user 的 API
    url(r'^api/users/(?P<pk>[0-9]+)/$', user_detail, name='user-detail'),

    # 所有 book 的 API
    url(r'^api/books/$', book_list, name='book-list'),
    # 单个 book 的 API
    url(r'^api/book/(?P<pk>[0-9]+)/$', book_detail, name='book-detail'),
]




使用路由

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

这是我们重写的 urls.py 文件。

from django.conf.urls import url
from django.contrib import admin
from rest_framework.routers import DefaultRouter

from myApp import apis


router = DefaultRouter()
router.register(r'^api/users', apis.UserViewSet)
router.register(r'^api/books', apis.BookViewSet)

urlpatterns = [
    url(r'^admin/', admin.site.urls),
]

urlpatterns = urlpatterns + router.urls
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,552评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,666评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,519评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,180评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,205评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,344评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,781评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,449评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,635评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,467评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,515评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,217评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,775评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,851评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,084评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,637评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,204评论 2 341

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,570评论 18 139
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 11,988评论 4 60
  • 2016年6月26日,此时,我正坐在一个房间里面,房间里面有三个人,除了我,还有一对情侣。 我戴着耳机,里面单曲循...
    桃二汪阅读 357评论 0 2
  • 如果说《小狗钱钱1》是作者以小狗钱钱的口吻来教我们理财知识,建立其初步的理财系统和理财知识,那么《小狗钱钱2》一定...
    十八_阅读 115评论 0 0