06_Tutorial 6: ViewSets & Routers 视图集与路由器
1、Tutorial 6: ViewSets & Routers 视图集与路由器
0、文档
https://q1mi.github.io/Django-REST-framework-documentation/tutorial/6-viewsets-and-routers_zh/
https://www.django-rest-framework.org/tutorial/6-viewsets-and-routers/
源码参考 https://github.com/encode/rest-framework-tutorial
1、viewsets.ReadOnlyModelViewSet
ReadOnlyModelViewSet
类来自动提供默认的“只读”操作
不再需要向两个不同的类提供相同的信息
from rest_framework import viewsets
class UserViewSet(viewsets.ReadOnlyModelViewSet): # 提供默认的“只读”操
"""
此视图自动提供list与detail操作
"""
queryset = User.objects.all()
serializer_class = UserSerializer
2、viewsets.ModelViewSet
使用了ModelViewSet
类来获取完整的默认的读写,增删改查操作
class SnippetViewSet(viewsets.ModelViewSet):
"""
此视图,自动提供,list,create,retrieve,update,和destroy操作
此外,我们还提供一个额外的 highlight操作
"""
queryset = Snippet.objects.all()
serializer_class = SnippetSerializer
permission_classes = [permissions.IsAuthenticatedOrReadOnly, IsOwnerOrReadOnly] # @detail_route(renderers_classes=[renderers.StaticHTMLRenderer])
# 默认get请求, action 包含detail_route
# url_path, 默认为函数name, 可以修改
# url_name默认为函数name,替换('_', '-') 修改会报错
@action(methods=['get'], detail=True, url_path='test', renderer_classes=[renderers.StaticHTMLRenderer])
def highlight(self, request, *args, **kwargs):
snippet = self.get_object()
return Response(snippet.highlighted) def perform_create(self, serializer): # 外键的POST操作,save
serializer.save(owner=self.request.user)
3、外键save
def perform_create(self, serializer): # 外键的POST操作,save
serializer.save(owner=self.request.user)
序列化是什么呢
class SnippetSerializer(serializers.ModelSerializer): owner = serializers.ReadOnlyField(source='owner.username') # source参数控制哪个属性用于填充字段
# # 它包含一个url字段 该snippet的highlight
# 单个字段,继承与HyperlinkedRelatedField
highlight = serializers.HyperlinkedIdentityField(view_name='snippet-highlight', format='html') class Meta:
model = Snippet
fields = ['url', 'id', 'title', 'code', 'linenos', 'language', 'style', 'owner', 'highlight']
4、action=detail_route + list_route
@action装饰器创建了一个名为highlight的自定义操作。此装饰器可用于添加任何不符合标准创建/更新/删除样式的自定义端点。
默认情况下,使用@action装饰器的自定义操作将响应GET请求。如果我们想要一个响应POST请求的操作,我们可以使用方法参数。
默认情况下,自定义操作的url依赖于方法名称本身,希望更改url的构造方式,可以将url_path作为修饰符关键字参数包含进来。
# 替换SnippetList,SnippetDetail和SnippetHighlight视图类
from rest_framework.decorators import detail_route
from rest_framework.decorators import action class SnippetViewSet(viewsets.ModelViewSet):
"""
此视图,自动提供,list,create,retrieve,update,和destroy操作
此外,我们还提供一个额外的 highlight操作
"""
queryset = Snippet.objects.all()
serializer_class = SnippetSerializer
permission_classes = [permissions.IsAuthenticatedOrReadOnly, IsOwnerOrReadOnly] # @detail_route(renderers_classes=[renderers.StaticHTMLRenderer])
# 默认get请求, action 包含detail_route
# url_path, 默认为函数name, 可以修改
# url_name默认为函数name,替换('_', '-') 修改会报错
@action(methods=['get'], detail=True, url_path='test', renderer_classes=[renderers.StaticHTMLRenderer])
def highlight(self, request, *args, **kwargs):
snippet = self.get_object()
return Response(snippet.highlighted) def perform_create(self, serializer): # 外键的POST操作,save
serializer.save(owner=self.request.user)
5、lowb:将ViewSets绑定到URL
我们是如何通过将http方法绑定到每个视图所需的操作,从每个ViewSet
类创建多个视图的
from snippets.views import SnippetViewSet, UserViewSet, api_root
from rest_framework import renderers # 明确地将ViewSets绑定到URL
snippet_list = SnippetViewSet.as_view({
'get': 'list',
'post': 'create'})
snippet_detail = SnippetViewSet.as_view({
'get': 'retrieve',
'put': 'update',
'path': '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'
})
urlpatterns = format_suffix_patterns([
path('', api_root), # 主index页面 path('snippets/', snippet_list, name='snippet-list'), # name用法,配合reverse('snippet-list')
path('snippets/<int:pk>/', snippet_detail, name='snippet-detail'),
path('snippets/<int:pk>/highlight/', snippet_highlight, name='snippet-highlight'), path('users/', user_list, name='user-list'),
path('users/<int:pk>', user_detail, name='user-detail'),
])
6、专业:使用路由器 Using Routers
使用的是ViewSet
类而不是View
类,我们实际上不需要自己设计URL
将资源连接到视图和url的约定可以使用Router
类自动处理。
我们需要做的就是使用路由器注册相应的视图集,然后让它执行其余操作。
DefaultRouter
类也会自动为我们创建API根视图
### 62使用路由器 Using Routers
###############
# 我们使用的是ViewSet类而不是View类,我们实际上不需要自己设计URL
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from snippets import views # 创建路由器并注册我们的视图。
router = DefaultRouter()
router.register(r'snippets', views.SnippetViewSet)
router.register(r'users', views.UserViewSet) urlpatterns = [
path('', include(router.urls)),
] ##########
# Tutorial 4: Authentication & Permissions
############
# 可浏览API的登录和注销视图
urlpatterns += [
path('api-auth/', include('rest_framework.urls', namespace='rest_framework')), # restframework自带的urls
]
06_Tutorial 6: ViewSets & Routers 视图集与路由器的更多相关文章
- Django(58)viewsets视图集详解
前言 ViewSet 只是一种基于类的视图,它不提供任何方法处理程序(如 .get()或.post()),而是提供诸如.list()和 .create() 之类的操作. ViewSet 的方法处理程序 ...
- Django REST framework 第六章 ViewSets & Routers
REST framework包含了一个可以处理ViewSets的抽象, 它允许开发人员专注于API的状态跟交互进行建模,并使得URL构建结构基于通用的约定自动处理. ViewSet类跟View类几乎相 ...
- 068.Python框架Django之DRF视图集使用
一 视图集与路由的使用 使用视图集ViewSet,可以将一系列逻辑相关的动作放到一个类中: list() 提供一组数据 retrieve() 提供单个数据 create() 创建数据 update() ...
- 对drf视图集的理解
视图集ViewSet 使用视图集ViewSet,可以将一系列逻辑相关的动作放到一个类中: list() 提供一组数据 retrieve() 提供单个数据 create() 创建数据 update() ...
- DRF中五大扩展类及视图集的介绍
五个扩展类 (1)ListModelMixin 列表视图扩展类,提供list(request, *args, **kwargs)方法快速实现列表视图,返回200状态码. 该Mixin的list方法会对 ...
- DRF视图集的路由设置
在使用DRF视图集时,往往需要配一大堆路由,例如: # views.py class DepartmentViewSet(ListModelMixin,CreateModelMixin,Retriev ...
- DRF中的视图集的使用
1.说明:DRF框架中的视图集: 在drf开发接口中,使用GenericAPIView和视图扩展类结合起来完成接口功能是一件很常见的事情,所以,drf的作者帮我们提前把 GenericAPIView ...
- 小波说雨燕 第三季 构建 swift UI 之 UI组件集-视图集(六)Picker View视图 学习笔记
想对PickerView进行操作,只能在代码中操作. 下面 ,再添加三个label组件,然后将所有组件配置到代码中(看代码),然后要实现对PickerView的操作,就要实现它的DataSource协 ...
- Tutorial 6: ViewSets & Routers
转载自:http://www.django-rest-framework.org/tutorial/6-viewsets-and-routers/ Tutorial 6: ViewSets & ...
随机推荐
- python基础学习(七)
14.return # print() 可以被执行 def doubelNumber(num): print() print() Afnum = doubelNumber() print(Afnum) ...
- PAT(B) 1053 住房空置率(Java)统计
题目链接:1053 住房空置率 (20 point(s)) 题目描述 在不打扰居民的前提下,统计住房空置率的一种方法是根据每户用电量的连续变化规律进行判断.判断方法如下: 在观察期内,若存在超过一半的 ...
- linux学习之路(二)--centos7安装Redis(单点)
一.安装redis 1.进入/usr/local/,新建services目录,进入该目录,下载redis wget http://download.redis.io/releases/redis-4. ...
- hdu 1501 贪心问题
这道题目的关键就是逐个搜索的过程 找个时间得复习一下dfs了 这里使用temp作为参照变量 每次比较以后(由于已经排序好) 已temp为参照进行下一次的比较
- 在论坛中出现的比较难的sql问题:26(动态行专列+合并字符串、补足行数)
原文:在论坛中出现的比较难的sql问题:26(动态行专列+合并字符串.补足行数) 最近,在论坛中,遇到了不少比较难的sql问题,虽然自己都能解决,但发现过几天后,就记不起来了,也忘记解决的方法了. 所 ...
- Python之数据处理-2
一.数据处理其实是一个很麻烦的事情. 在一个样本中存在特征数据(比如:人(身高.体重.出生年月.年龄.职业.收入...))当数据的特征太多或者特征权重小或者特征部分满足的时候. 这个时候就要进行数据的 ...
- C++报错:error C3874
解决: 1.class 定义之后不要忘记分号 2.主函数写为int main() { }
- Eva 剧情解析
Eva 剧情解析 来源 https://zhuanlan.zhihu.com/p/20864898 [0.写在前面的话] 相信和我年龄差不多的小伙伴们对<新世纪福音战士>( <Neo ...
- POJ1611(The Suspects)--简单并查集
题目在这里 关于SARS病毒传染的问题.在同一个组的学生是接触很近的,后面也会有新的同学的加入.其中有一位同学感染SARS,那么该组的所有同学得了SARS.要计算出有多少位学生感染SARS了.编号为0 ...
- 3.Ubuntu/Deepin下安装Monaco/Menlo字体
前段时间在一家公司实习,让IT给电脑安装了Ubuntu系统,用着挺好,但总感觉字体不太好看,网上小伙伴说Monaco字体不错,所以计划安装试试. 看了好多教程,不得不说,一些教程走下来真心是装不成功, ...