django rest framework快速入门第六章 ViewSets和Routers

第六章 ViewSets和Routers

写在前面:
本文翻译于django rest framework官方文档,由于网上大多数django rest framework中文翻译文档都有较为多的删减行为,笔者在学习的时候就觉得不是太方便,故笔者将官方文档较为完善的为大家翻译下,仅供大家学习参考。++由于笔者文笔有限,若有写得不当之处,敬请各位同仁指出;若涉及到侵权,请联系笔者,笔者将立即删除。++

REEST Framework包括了一个用于处理ViewSets的机制,能够让开发人员集中精力于对API的状态和交互进行建模,并根据约定自动处理URL构造。

可以说ViewSets类和View类几乎是一样的,他们提供readupdate之类的操作外,而不是getput等方法处理程序

一个ViewSets类只在最后时刻绑定到一组方法处理程序中,当他被实例化为一组视图时,通常会用到一个叫Router的类来定义URL conf的复杂性。

1. 重构代码以使用ViewSets

我们现在重构我们的UserListUserDetail,使用一个简单的UserViewSets。我们可以移除这两个视图,用一个简单的类来替换他们

from rest_framework import viewSets

class UserViewSet(viewsets.ReadOnlyModelViewSet):
'''
这个视图集自动的提供了“list”和“detail“操作
'''
queryset = User.objects.all()
serializer_class = UserSerializer

在这里我们使用ReadOnlyModelViewSet来自动提供默认的read-only操作,我们需要和使用常规视图一样设置querysetserializer_class属性。但我们不需要将同样的信息分割到两个类中去。

同理,我们在使用SnippetViewSet来代替SnippetListViewSnippetDetailView


class SnippetViewSet(viewsets.ModelViewSet):
    """
    这个视图集自动的提供了增删查改的功能
    """
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer
    permission_classes = (permissions.IsAuthenticatedOrReadOnly,
                          IsOwnerOrReadOnly,)

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

这次我们使用了ModelViewSet类来获得一组完整的默认读写操作,因为这个类不像用户类一样,这个类是可读可写的。

2. 显式的将ViewSets绑定到URL

当我们定义到URL Conf时,处理程序方法只绑定到动作。

urls.py

from snippets.views import SnippetViewSet, UserViewSet, api_root

snippet_list = SnippetViewSet.as_view({
    'get': 'list',
    'post': 'create'
})
snippet_detail = SnippetViewSet.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'
})

可以注意到我们在一个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'^users/$', user_list, name='user-list'),
    url(r'^users/(?P<pk>[0-9]+)/$', user_detail, name='user-detail')
])

3. 使用Routers

因为我们现在是用的是ViewSets而不是View,所以我们不需要自己去设计URL Conf。将资源接入视图和网址的约定可以使用Router类来自动处理。所有我们需要做的就是使用一个router来注册适当,它自己就会把其他的都做了。

接下来的就是我们重新接入的 urls.py 文件。

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

router = DefaultRouter()
router.register(r'snippets', views.SnippetViewSet)
router.register(r'users', views.UserViewSet)

urlpatterns = [
    url(r'^', include(router.urls.)),
    url(r'^api-auth/', include("rest_framework.urls", namespace="rest_framework"))
]

用router注册视图集类似于提供urlpatterns,我们包括了两个参数,视图的URL前缀和视图集本身

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

4. 视图与视图集之间的平衡

使用视图集是一种很好的方式,它有助于确保URL约定在你的API之间保持一致,最大限度的减少您需要编写的代码量,并且允许你专注于API提供的交互和表示,而不是具体的URL conf。

但这并不意味着它总是最好的方法。当使用基于类的视图的时候,需要考虑一组类似的权衡,与单独构建的视图相比,使用视图集不够明确。

5. 下一步

在本教程的第七部分,我们将讨论如何添加API模式,并使用客户端或命令行工具与我们的API进行交互

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

推荐阅读更多精彩内容