drf 框架
一. drf简介
drf框架,全程: django-rest framework , rest是插件名字,django插件的名字叫rest,framework是框架的意思
二. 接口
在平时生活中,接口是联系两个物质的媒介, 完成信息的交互. 在web程序中是联系前台页面与后台数据库的媒介
web接口组成: url: 长得像返回数据(api.baidu.map/search)的url链接,长得像还不一定就是接口,还要有请求参数,接口一定要告诉前台要给我传什么参数,比如登录接口要传用户名和密码,请求参数: 前台按照指定的key提供数据给后台, 为什么按指定的key提供,因为后台在request中get的时候按写死的字符串,前端不按照这些字符串提,后端就提不出来,所以后台占主导,后台要什么前台就返回什么,另外响应数据,比如注册,注册成功的时候起码要返回一个注册成功.我才知道注册侧成功了,后台与用户交互的信息,前台应该多少知道点,玩意没有返回给前端,前端就会断了,响应数据就是后台与数据库交互后将数据反馈给前端,综合以上分析,可以得出结论,接口就是一个规定了请求参数的url,访问后能返回对应结果.
三. restful接口规范
接口规范: 为了采用不同的后台语言,也能使用同样的接口获取到同样的数据
如何学习: 接口规范是规范化书写接口的,写接口要写url, 响应数据.
注意: 如果将请求参数也纳入考量范围,那就是在写接口文档,这个接口文档最主要的还是给前台看
最主要的接口规范还是两大部分:
url: 用api关键字标识接口url(api.baidu.com | www.baidu.com/api ); 接口数据安全性决定优先选择https协议; 如果一个接口有多版本存在,需要在url中标识体现; 接口操作的数据源(api.baidu.com/books)称之为资源(book), 在url中一般采用资源复数形式,一个接口可以概括对资源的多种操作方式,(原来学的是一个视图对应的一个接口,一个接口做一个操作,从本节起就要写cbv,一个类中写一堆方法,一个方法一项业务逻辑,就属于一个类,接口就是跟类进行绑定的,那么代码怎么组装,我们的接口就怎么组装,也就是一个url对应一个类), 以前的就是这种: api.baidu.com/delete_book, 从现在起就要写成api.baidu.com/books,操作单个资源的话还可以这样写: api.baidu.com/books/(pk),比如增加或者删除某个书; 这里就有疑问了,请求方式有多种,用一个url处理如何保证不混乱-通过请求方式标识操作资源的方式:
/books 发送的是get请求 获取所有 /books post 增加一个(多个) /books/(pk) delete 删除一个 /books(pk) put 整体更新一个/books(pk) patch 局部更新一个
资源往往涉及数据的各种操作方式-筛选,排序,限制 比如api.baidu.com/books/?search=西&ordering=-price&limit=3
search=西 是查询跟'西'有关系的,ordering=-price 价格降序 limit=3,三位数
响应数据:
1. http请求的响应会有响应状态码,接口用来返回操作的资源数据, 可以拥有操作数据结果的状态码;
注意: 资源状态码不像http状态码, 一般都是后台与前台或是客户约定的
2. 资源的状态码文字提示 status OK '账号有误' '密码有误' '用户锁定' ;
3. 资源本身 results ;
注意: 删除资源成功不做任何数据返回(返回空字符串)
4. 不能直接返回的资源(子资源, 图片, 视频等资源), 返回该资源的url链接
四. 基于restful规范的原生django接口
主路由: url.py
from django.conf.urls import url, include from django.contrib import admin urlpatterns = [ url(r'^admin/', admin.site.urls), # 路由分发 url(r'^api/', include('api.urls')) ]
api组件(在项目的目录下建立的api的包)的子路由: api/url.py
from django.conf.urls import url from . import views urlpatterns = [ url(r'^books/', views.Book.as_view()), url(r'^books/(?P<pk>.*)/$', views.Book.as_view()), ]
模型层: model.py
from django.db import models class Book(models.Model): title = models.CharField(max_length=64) price = models.DecimalField(max_digits=5, decimal_places=2) class Meta: db_table = 'old_boy_book' verbose_name = '书籍' # 告诉后台管理将book转化为汉字"书籍" verbose_name_plural = verbose_name # 去掉后台管理的book后面的s def __str__(self): return '《%s》' % self.title
后台层: admin.py
from django.contrib import admin from . import models admin.site.register(models.Book)
数据库迁移
>: python manage.py makemigrations >: python manage.py migrrate >: python manage.py createsuperuser
视图层: views.py
from django.http import JsonResponse from django.views import View from . import models # 六大基础接口:获取一个 获取所有 增加一个 删除一个 整体更新一个 局部更新一个 # 十大接口:群增 群删 整体改群改 局部改群改 class Book(View): def get(self, request, *args, **kwargs): pk = kwargs.get('pk') if not pk: # 群查 # 操作数据库 book_obj_list = models.Book.objects.all() # 没有pk就是查所有 # 序列化过程 book_list = [] for obj in book_obj_list: dic = {} dic['title'] = obj.title # 将对象转化为字典 dic['price'] = obj.price book_list.append(dic) # 每次循环都产生一个 # 响应数据 return JsonResponse({ 'status': 0, 'msg': 'ok', 'results': book_list }, json_dumps_params={'ensure_ascii': False}) # 将页面上的字符串进行反序列化 else: # 单查 book_dic = models.Book.objects.filter(pk=pk).values('title', 'price').first() if book_dic: return JsonResponse({ 'status': 0, 'msg': 'ok', 'results': book_dic }, json_dumps_params={'ensure_ascii': False}) return JsonResponse({ 'status': 2, 'msg': '无结果', }, json_dumps_params={'ensure_ascii': False}) postman可以完成不同方式的请求:get | post | put ... postman发送数据包有三种方式:form-data | urlencoding | json 原生django对urlencoding方式数据兼容最好 def post(self, request, *args, **kwargs): 前台通过urlencoding方式提交数据 try: book_obj = models.Book.objects.create(**request.POST.dict()) if book_obj: return JsonResponse({ 'status': 0, 'msg': 'ok', 'results': {'title': book_obj.title, 'price': book_obj.price} }, json_dumps_params={'ensure_ascii': False}) except: return JsonResponse({ 'status': 1, 'msg': '参数有误', }, json_dumps_params={'ensure_ascii': False}) return JsonResponse({ 'status': 2, 'msg': '新增失败', }, json_dumps_params={'ensure_ascii': False})
五. postman接口工具
官网下载安装
get请求,携带参数采用Params
postman可以完成不同方式的请求,原生django对urlencoding方式数据兼容最好
post等请求,可以使用postman,提交数据包可以采用三种方式:form-date、urlencoding、json, 这些在body内发送数据
所有请
postman主页面
输入对应的url
六. DRF框架
安装:
>: pip3 install djangorestframework
安装完成后去seetings注册,没有注册app可以访问里面的类,但是数据库迁移的时候无法检测到model ,在settings里面没有注册的话,有时候逻辑是可以使用的,但是有些功能是使用不了的,pep8规定在最上方写系统的,接下来写第三方的,最后写自己的
drf框架规矩的封装风格
from rest_framework.views import APIView # 完成视图 from rest_framework.response import Response # 响应数据 from rest_framework.request import Request # 请求数据 from rest_framework.serializers import Serializer from rest_framework.settings import APISettings from rest_framework.filters import SearchFilter # 查询过滤器 from rest_framework.pagination import PageNumberPagination # 分页器 from rest_framework.authentication import TokenAuthentication # auth认证 from rest_framework.permissions import IsAuthenticated # 权限认证 from rest_framework.throttling import SimpleRateThrottle # 频率 class Test(APIView): def get(self, request, *args, **kwargs): return Response('drf get ok')
drf请求生命周期
1) 请求走的是APIView的as_view函数 2) 在APIView的as_view调用父类(django原生)的as_view,还禁用了 csrf 认证 3) 在父类的as_view中dispatch方法请求走的又是APIView的dispatch 4) 完成任务方法交给视图类的请求函数处理,得到请求的响应结果,返回给前台
七. 请求模块: request对象
源码入口:
APIView类的dispatch方法中:request = self.initialize_request(request, *args, **kwargs)
源码分析:
# 二次封装得到def的request对象 request = self.initialize_request(request, *args, **kwargs) 点进去 # 在rest_framework.request.Request实例化方法中 self._request = request 将原生request作为新request的_request属性 # 在rest_framework.request.Request的__getattr__方法中 try: return getattr(self._request, attr) # 访问属性完全兼容原生request except AttributeError: return self.__getattribute__(attr)
重点总结:
1) drf 对原生request做了二次封装,request._request就是原生request 2) 原生request对象的属性和方法都可以被drf的request对象直接访问(兼容) 3) drf请求的所有url拼接参数均被解析到query_params中,所有数据包数据都被解析到data中
class Test(APIView): def get(self, request, *args, **kwargs): # url拼接的参数 print(request._request.GET) # 二次封装方式 print(request.GET) # 兼容 print(request.query_params) # 拓展 return Response('drf get ok') def post(self, request, *args, **kwargs): # 所有请求方式携带的数据包 print(request._request.POST) # 二次封装方式 print(request.POST) # 兼容 print(request.data) # 拓展,兼容性最强,三种数据方式都可以 print(request.query_params) return Response('drf post ok')
八. 渲染模块: 浏览器和postman请求结果渲染数据的方式不一样
源码入口:
APIView类的dispatch方法中:self.response = self.finalize_response(request, response, *args, **kwargs)
源码分析
最后解析reponse对象数据 self.response = self.finalize_response(request, response, *args, **kwargs) 点进去 拿到运行的解析类的对象们 neg = self.perform_content_negotiation(request, force=True) 点进去 获得解析类对象 renderers = self.get_renderers() 点进去 从视图类中得到renderer_classes请求类,如何实例化一个个对象形参解析类对象列表 return [renderer() for renderer in self.renderer_classes] 重点:self.renderer_classes获取renderer_classes的顺序 自己视图类的类属性(局部配置) => APIView类的类属性设置 => 自己配置文件的DEFAULT_RENDERER_CLASSES(全局配置) => drf配置文件的DEFAULT_RENDERER_CLASSES
全局配置: 所有视图类统一处理,在项目的settings.py中
REST_FRAMEWORK = { # drf提供的渲染类 'DEFAULT_RENDERER_CLASSES': [ 'rest_framework.renderers.JSONRenderer', 'rest_framework.renderers.BrowsableAPIRenderer', ], }
局部配置: 某一个或一些实体类单独处理,在views.py视图类中提供对应的类属性
class Test(APIView): def get(self, request, *args, **kwargs): return Response('drf get ok') def post(self, request, *args, **kwargs): return Response('drf post ok') # 在setting.py中配置REST_FRAMEWORK,完成的是全局配置,所有接口统一处理 # 如果只有部分接口特殊化,可以完成 - 局部配置 from rest_framework.renderers import JSONRenderer class Test2(APIView): # 局部配置 renderer_classes = [JSONRenderer] def get(self, request, *args, **kwargs): return Response('drf get ok 2') def post(self, request, *args, **kwargs): return Response('drf post ok 2')
drf 框架的更多相关文章
- DRF框架之认证组件用法(第四天)
1. 什么是drf 框架的认证组件: auth 就等于是jango中的Auth模块,Auth是自带session信息,但是 drf的认证组件可以自定义token携带过去,去判断用的 2.如何实现认证呢 ...
- DRF框架之视图方法的几个封装好的模块介绍(第三天)
1.DRF框架给我们封装好了好多层模块的 来实现简便接口的编写 # from rest_framework.mixins import CreateModelMixin, UpdateModelMix ...
- 一、restful规范 二、CBV(View)源代码执行流程 三、drf框架安装和简单使用
一.restful规范 ''' 它是一个规范,面向资源架构 十条规范 1.API与用户的通讯协议,总是使用HTTPs协议,确保了网络传输的安全性 2.域名 --https://api.example. ...
- DRF框架之 serializers 序列化组件
1. 什么是序列化,其实在python中我们就学了序列化工具json工具,就是吧信息存为类字典形式 2. DRF框架自带序列化的工具: serializers 3. DRF框架 serializers ...
- DRF框架简介(第一天)
1.drf框架全称 djangorestframework 1.如何安装drf框架: pip3 install djangorestframework #drf框架其实就是一个app称之为drf #d ...
- 写写Django中DRF框架概述以及序列化器对象serializer的构造方法以及使用
写写Django中DRF框架概述以及序列化器对象serializer的构造方法以及使用 一.了解什么是DRF DRF: Django REST framework Django REST framew ...
- django drf框架中的user验证以及JWT拓展的介绍
登录注册是几乎所有网站都需要去做的接口,而说到登录,自然也就涉及到验证以及用户登录状态保存,最近用DRF在做的一个关于网上商城的项目中,引入了一个拓展DRF JWT,专门用于做验证和用户状态保存.这个 ...
- DRF框架学习总结
DRF框架安装配置及其功能概述 Django与DRF 源码视图解析 DRF框架序列化和返序列化 DRF框架serializers中ModelSerializer类简化序列化和反序列化操作 DRF源码s ...
- drf框架接口文档
drf框架接口文档 REST framework可以自动帮助我们生成接口文档. 接口文档以网页的方式呈现. 自动接口文档能生成的是继承自APIView及其子类的视图. 一.安装依赖 pip insta ...
随机推荐
- fastjson对象,JSON,字符串,map之间的互转
1.对象与字符串之间的互转 将对象转换成为字符串 String str = JSON.toJSONString(infoDo); 字符串转换成为对象 InfoDo infoDo = JSON.pars ...
- Navicate for mysql如何导入一个sql文件
我在做的项目是宜立方商城的项目,现在需要把见表的sql文件导入到navicate中去,步骤如下: ①新建一个数据库,如下: ②在数据库名字上右键,选择运行sql文件 ③选择如下sql文件 ④刷新之后:
- FreeSql (十九)多表查询
多表查询,常用的有联表 LeftJoin/InnerJoin/RightJoin ,这三个方法在上篇文章已经介绍过. 除了联表,还有子查询 Where Exists,和 Select 子表: IFre ...
- FreeSql (三十一)分区分表
分区 分区就是把一个数据表的文件和索引分散存储在不同的物理文件中.把一张表的数据分成N多个区块,这些区块可以在同一个磁盘上,也可以在不同的磁盘上,数据库不同实现方式有所不同. 与分表不同,一张大表进行 ...
- SpringBoot系列——Security + Layui实现一套权限管理后台模板
前言 Spring Security官网:https://spring.io/projects/spring-security Spring Security是一个功能强大且高度可定制的身份验证和访问 ...
- ubuntu连接window系统
最后可以通过次命令挂载本地文件夹到远程电脑: rdesktop -a 24 -f -r disk:share-name=/home/lion/.m2/ 192.168.151.232
- 30 (OC)* 数据结构和算法
在描述算法时通常用o(1), o(n), o(logn), o(nlogn) 来说明时间复杂度 o(1):是最低的时空复杂度,也就是耗时/耗空间与输入数据大小无关,无论输入数据增大多少倍,耗时/耗空间 ...
- Spring Cloud 负载均衡初体验
目录 服务搭建 1.注册中心--Eureka Server 2.服务提供方--Service Provider 3.服务消费方--Service Consumer 服务消费 Feign 与断路器 Hy ...
- 《HelloGitHub》第 42 期
兴趣是最好的老师,HelloGitHub 就是帮你找到兴趣! 简介 分享 GitHub 上有趣.入门级的开源项目. 这是一个面向编程新手.热爱编程.对开源社区感兴趣 人群的月刊,月刊的内容包括:各种编 ...
- Eclipse的egit插件冲突合并方法
Eclipse有一个git的插件叫EGit,用于实现本地代码和远程代码对比.合并以及提交.但是在本地代码和远程代码有冲突的时候,EGit的处理方案还是有点复杂.今天就彻底把这些步骤给理清楚,并公开让一 ...