django的restfulapi
Django Rest framework 的流程大概是这样的
- 建立 Models
- 依靠 Serialiers 将数据库取出的数据 Parse 为 API 的数据(可用于返回给客户端,也可用于浏览器显示)
- ViewSet 是一个 views 的集合,根据客户端的请求(GET、POST等),返回 Serialiers 处理的数据
- 权限 Premissions 也在这一步做处理
- ViewSet 可在 Routers 进行注册,注册后会显示在 Api Root 页上
- 在 urls 里注册 ViewSet 生成的 view,指定监听的 url
Serializers,这个相当于 Django 的 Form
其实 viewset 反而是最简单的部分,rest_framework 原生提供了四种 ViewSet
ViewSet
GenericViewSet
- 继承于
GenericAPIView
- 继承于
ModelViewSet
- 自身提供了六种方法
list
create
retrieve
update
partial_update
destroy
ReadOnlyModelViewSet
class DataBaseInfoViewSet(viewsets.ModelViewSet):
permission_classes = (permissions.IsAuthenticated,)
queryset = DataBaseInfo.objects.all()
serializer_class = DataBaseInfoSerializer
filter_backends = (filters.DjangoFilterBackend,)
filter_fields = [
'id',
'db_name', ] def get_queryset(self):
queryset = self.queryset
queryset = queryset.prefetch_related('create_user')
return queryset
Filters
前面根据 serializers 和 viewset 我们已经可以很好的提供数据接口和展示了。但是有时候我们需要通过 url参数 来对数据进行一些排序或过滤的操作,为此,rest-framwork 提供了 filters 来满足这一需求。
全局filter
可以在 settings 里指定应用到全局的 filter:
REST_FRAMEWORK = {
'DEFAULT_FILTER_BACKENDS': ('rest_framework.filters.DjangoFilterBackend',)}
viewset 的 filter
也可以为 viewset 分别指定 filter,方法就是在定义 viewset 的时候定义一个名为 filter_backend
的类变量:
class UserListView(generics.ListAPIView):
queryset = User.objects.all()
serializer = UserSerializer
filter_backends = (filters.DjangoFilterBackend,)
Premissions
顾名思义就是权限管理,用来给 ViewSet 设置权限,使用 premissions 可以方便的设置不同级别的权限:
- 全局权限控制
- ViewSet 的权限控制
- Method 的权限
- Object 的权限
被 premission 拦截的请求会有如下的返回结果:
- 当用户已登录,但是被 premissions 限制,会返回
HTTP 403 Forbidden
- 当用户未登录,被 premissions 限制会返回
HTTP 401 Unauthorized
默认的权限
rest_framework 中提供了七种权限
AllowAny
# 无限制IsAuthenticated
# 登陆用户IsAdminUser
# Admin 用户IsAuthenticatedOrReadOnly
# 非登录用户只读DjangoModelPermissions
# 以下都是根据 Django 的 ModelPremissionsDjangoModelPermissionsOrAnonReadOnly
DjangoObjectPermissions
全局权限控制
在 settings.py 中可以设置全局默认权限
# settings.py
REST_FRAMEWORK = {
'DEFAULT_PERMISSION_CLASSES': (
'rest_framework.permissions.AllowAny',
),}
ViewSet 的权限
可以设置 permission_classes
的类属性来给 viewset 设定权限,restframework 会检查元组内的每一个 premission,必须要全部通过才行。
class UserViewSet(viewsets.ReadOnlyModelViewSet):
queryset = User.objects.all()
serializer_class = UserSerializer
# 设置权限,是一个元组
permission_classes = (permissions.IsAuthenticated,)
创建序列器
序列器的作用
在开始 我们的 Web API 之前,我们需要考虑 如何完成 snippet 实例 的序列化和反序列化。在restframework 里面 这个动作被分成了2部分
1.序列器: 用于完成 实例 和 python数据结构的 转换
2.使用python的json模块来完成 python数据结构 和 json 数据结构的 转换 (Django对其进行了封装,restframework已对其进行了封装,这个后面会说)
因此这个 序列器的作用就是用来完成 实例和python数据结构的 一个转换, 因此这个概念和 Django 的from很像。他的定义方式也和Django Form很像,
定义序列器
定义一个序列器 主要需要定义2部分:
1. 定义序列化/反序列化的字段
2.重写Serializer类的 create方法,和update方法,这2个方法必须重写,因为 Serializer类的save方法会 调用 create方法和 update 方法来创建和更新数据, 这样将 create方法 和 update 方法独立出来, 让用户自己实现, 使得 serialzer 在序列化时 具有 高度的灵活性。
在 snippets app 下 创建一个 serializers.py文件
使用序列器
序列器仅能帮我们把 python数据结构(OrderedDict)和 snippets对象 进行转换, 如果想 转化成json数据格式,可以使用json模块,这里使用restframework为我们封装好的 JSONRender 和 JSONParser 对象 来完成 Json数据 和 python 数据的转换。
序列化
1.完成snippet对象和python内部数据结构(OrderedDict)的转换
2.完成python数据结构(OrderedDict) 到 Json数据结构的转换
反序列化
1.完成Json数据结构 到Python内部数据结构(OrderedDict)的转换
2.获得的python内部结构的数据 转换成 snippet对象(由于我们定义了 create 和 update方法,所有转换成snippet对象后 ,会隐式的存入数据库)
如何序列化queryset对象
默认情况下 序列器 仅能序列化一个对象,而 queryset 是 多个表实例对象的 列表。 因此如果想要一次序列化多个对象, 也就是序列化queryset对象
Serializer 类提供了一个 布尔选项,只要开启这个布尔选项(many=True),那么就可以序列化 queryset对象了
使用Model Serialser 优化 序列器
问题与优化
我们发现 序列器里面定义的字段, 基本都和 数据模型里面的 字段重复了, 为了保证代码的简洁,需要去重。
Django Form 提供 Form 和 ModleForm, 而restframework 也同时提供 Serializer 和 ModelSerializer
这里的ModleSerializer 就是使 序列器 的定义更简洁, 更优雅的一个类
注意,ModelSerializer 对于 Serializer 并没有做说明特别的 处理, 他的作用仅仅是我们建立序列器的一种 快捷方法,这里ModelSerializer帮我们做了2件事儿
1.根据Modle的字段 自动化设置序列器的字段类型
2.实现了默认的 create 方法, 和 update方法 (当然如果和我们的需求不想符, 你可以重写这些方法)
优化后的代码
修改snippets/serializers.py, 实现我们优化过后的 序列器定义方法
1
2
3
4
|
class SnippetSerializer(serializers.ModelSerializer): class Meta: model = Snippet fields = ( 'id' , 'title' , 'code' , 'linenos' , 'language' , 'style' )
|
Restframework 提供一种机制 来让 开发人员仅仅 专注于 模型和API交互 的开发, 这种机制就是 章要讲的 ViewSet 和 Router。
Viewset(集合视图)- 他将一组 相同资源的不同视图 ,集合成了一张视图, 而开人人员需要编写的是 对这个资源的处理方法(比如 read, update), 而不是实现http的处理方法(get, update)。因此 Viewset是一个抽象层, 他完成了 http方法 <—> 资源处理方法
Router(路由器)- 更具一种 共同的约定 自动处理url, 主要是url pattern的命名。
使用Router
Router功能简介
1. 分解viewset
Router会为我们完成view的分解, 但是分解是遵循一定规则的,Default Router 内置了一个默认映射表:
get — list
post — create
get — retrieve
put — update
patch — partial-update
delete — destroy
以上这些默认的方法,就是Default Router 的 标准方法
如果我们有自定义的 方法需要映射 就需要使用 2个装饰器 来完成映射: HTTP 方法 — 资源方法
@list_route
这个装饰器 会获取资源对象的列表, 常用于 需要操作多个对象的时候。
@detail_route
这个装饰器 包含一个 pk, 会获取对于 pk 的单个 资源对象。常用于 操作单个对象的时候。
method参数: 这两个装饰器 都可以传人一个 method 参数, 用于 指定这个 资源方法 映射的对应的 http方法。
其他关键字也可以传入
django的restfulapi的更多相关文章
- Django的RestfulAPI框架RestFramework
Django的Restful-API框架 安装框架 #sudo pip3 install django #sudo pip3 install markdown #sudo pip3 install d ...
- Django从Models 10分钟建立一套RestfulApi
目录 Django从Models 10分钟建立一套RestfulApi Django从Models 10分钟定制一个Admin后台 简介 Django是一套完善而强大的web开发框架, 结合Djang ...
- 【Django】 rest-framework和RestfulAPI的设计
[rest-framework] 这是一个基于django才能发挥作用的组件,专门用于构造API的. 说到API,之前在其他项目中我也做过一些小API,不过那些都是玩票性质,结构十分简单而且要求的设计 ...
- Django JWT Token RestfulAPI用户认证
一般情况下我们Django默认的用户系统是满足不了我们的需求的,那么我们会对他做一定的扩展 创建用户项目 python manage.py startapp users 添加项目apps INSTAL ...
- [django]restfulapi请求规范
http://www.ruanyifeng.com/blog/2014/05/restful_api.html 方法及作用: GET(SELECT) :从服务器取出资源(一项或多项). POST(CR ...
- Django Rest Framework-介绍
什么是RESTful REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为"表征状态转移" RE ...
- Django之REST framework源码分析
前言: Django REST framework,是1个基于Django搭建 REST风格API的框架: 1.什么是API呢? API就是访问即可获取数据的url地址,下面是一个最简单的 Djang ...
- 01: RestfulAPI与HTTP
1.1 RestfulAPI与HTTP简介 1.什么是RestfulAPI 1.REST直接翻译:表现层状态转移,实质就是一种面向资源编程的方法 2.REST描述的是在网络中client和server ...
- [py]django的manytomany字段和后台搜索过滤功能
我本来想搞下Django之select_related和prefetch_related的区别,看到这里有djangoapi的知识, 之前搞过django restfulapi,http://blog ...
随机推荐
- perl File::Spec 模块
File::Spec 模块提供了很多的功能,这里只列举几个常用的函数 rel2abs : 返回一个文件的绝对路径, 常见用法,返回当前运行的perl脚本的绝对路径 代码示例: my $prog = F ...
- CentOS Linux 下安装Samba
一.Samba简介: Samba是在Linux和UNIX系统上实现SMB协议的一个免费软件,由服务器及客户端程序构成.Linux中搭建环境有几个需要使用的软件包: (1)samba-client:这个 ...
- Android学习笔记——Menu(三)
知识点 今天继续昨天没有讲完的Menu的学习,主要是Popup Menu的学习. Popup Menu(弹出式菜单) 弹出式菜单是一种固定在View上的菜单模型.主要用于以下三种情况: 为特定的内容提 ...
- CSS清除浮动常用方法小结
1.使用空标签清除浮动.我用了很久的一种方法,空标签可以是div标签,也可以是P标签.我习惯用<P>,够简短,也有很多人用<hr>,只是需要另外为其清除边框,但理论上可以是任何 ...
- unity3d多个版本共存
用4.3打开两个低版本的unity工程,都报错.... 用低版本打开正常,希望Unity3D版本兼容性越来越好吧. 参考:http://blog.csdn.net/anyuanlzh/article/ ...
- #include”* .h“ 在查找预编译头使用时跳过
warning C4627: “#include <windows.h>”: 在查找预编译头使用时跳过 解决办法: 原因是没有在cpp文件最前一行添加没有添加 #include &quo ...
- Zookeeper安装和配置详解
http://coolxing.iteye.com/blog/1871009 Zookeeper是什么 http://www.cnblogs.com/yuyijq/p/3391945.html Zoo ...
- Java精选笔记_Filter(过滤器)
Filter(过滤器) Filter入门 什么是Filter Filter被称作过滤器或者拦截器,其基本功能就是对Servlet容器调用Servlet的过程进行拦截,从而在Servlet进行响应处理前 ...
- linux下更改vncserver的密码
Linux下VNC配置多个桌面和修改密码 1:vncserver2:iptables -I INPUT -p tcp --dport 5901 -j ACCEPT 客户端方式3:iptables ...
- python文件和目录操作方法大全(含实例)【python】
转自:http://www.jb51.net/article/48001.htm 一.python中对文件.文件夹操作时经常用到的os模块和shutil模块常用方法. 1.得到当前工作目录,即当前Py ...