drf框架
drf全称:django-rest framework
drf框架作用:写接口
什么是接口:
明确了请求方式,提供对应后台所需参数,请求url链接可以得到后台的响应数据
怎样写接口:
参照某种规则(规范)书写url链接,同时根据规则制定请求方式,请求数据与响应结果
接口文档:
提供给前后端开发人员与测试人员查看
接口规范:
webapi接口规范:restful
接口
接口:联系两个物质的媒介,完成信息交互
web程序中:联系前台页面与后台数据的媒介
web接口组成:
url:长得像返回数据的url连接
请求参数:前台按照指定的key提供数据给后台
响应数据:后台与数据库交互将数据反馈给前台
restful接口规范
接口规范:就是为了采用不同的后台语言,也能使用同样的接口获取到同样的数据
如何写接口:接口规范是 规范化书写接口的,写接口要写 url、响应数据
注:如果将请求参数也纳入考量范围,那就是在写 接口文档
.url
1.用api关键字标识接口url
api.baidu.com | www.baidu.com/api
2.接口数据安全性决定优先选择 https 协议
3.如果一个接口有多版本数据存在,需要在url中标识提现
api.baidu.com/v1/... | api.baidu.com/v2/...
4.接口操作的数据源称之为 资源,在url中一般采用资源的复数形式,一个接口可以概括对该资源的多种操作方式
api.baidu.com/books | api.baidu.com/books/(pk)
5.请求方式有多种,用一个url处理如何保证不乱---通过请求方式标识操作资源的方式
/books get 获取所有/获取一个
/books post 增加一个(多个)
/books(pk) delete 删除一个 params传参
/books(pk) put 整体更新一个
/books(pk) patch 局部更新一个
6.资源往往涉及数据的各种操作方式---筛选、排序、限制
api.baidu.com/books/?search=西游记&ordering=-price&limit=3
响应数据
就是通过 JsonResponse,返回给前端的数据
1.http请求的响应会有响应状态码,接口用来返回操作的资源数据,可以拥有操作数据结果的状态码
status 0(操作资源成功) 1(操作资源失败) 2(操作资源成功,但没有匹配结果)
注意:“资源状态码不像http状态码,一般都是后台与前台或者客户约定的”
2.资源的状态码文字提示
status ok '账户有误' '密码有误' '用户锁定'
3.资源本身
results
注:删除资源成功不做任何数据返回(返回空字符串),但仍有人不遵守这个规范
4.如有不能直接返回的资源(子资源、图片、视频等)。返回该资源的url链接
基于restful规范的原生Django接口
用规范的方法写我们之前的django范例
主路由 urls.py
from django.conf.urls import url,include
from django.contrib import admin
urlpatterns = [
url(r'^admin/', admin.site.urls),
url(r'^app01/', include('app01.urls')),
]
应用app01下的urls.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()),
]
模型层 models.py 创建数据
from django.db import models
class Book(models.Model):
name = models.CharField(max_length=64)
price = models.DecimalField(max_digits=5,decimal_places=2) #生成五位数,小数两位
视图层:views.py
from django.http import JsonResponse
from django.views import View
# Create your views here.
from . import models
from rest_framework.views import APIView
class Book(View):
def get(self, request, *args, **kwargs):
pk = kwargs.get('pk', None)
if pk: #单查
book_dic = models.Book.objects.filter(pk=pk).values('name', 'price').first()
results = book_dic
else: # 群查
book_query = models.Book.objects.values('name', 'price')
results = list(book_query)
if not results:
return JsonResponse({
'status': 1,
'msg': 'data error'
})
return JsonResponse({
'status': 0,
'msg': 'ok',
'results': results
})
Postman接口工具
前面的views视图,使用postman工具来访问
1.官网下载安装
2.get请求,携带参数采用Params,传值
3.post等请求,在Body里面加数据,提交数据包可以采用三种方式:form-date、urlencoding、json,原生的django对urlencoding方式数据兼容最好
所有请求都可以携带请求头
drf请求生命周期
1) 请求走的是APIView的as_view函数
2) 在APIView的as_view调用父类(django原生)的as_view,返回View函数,还禁用了 csrf 认证
3) 在父类的as_view中dispatch方法请求走的又是APIView的dispatch
4) 完成任务方法交给视图类的请求函数处理,得到请求的响应结果,返回给前台
总结:CBV请求生命周期:as_view()完成路由匹配 => url请求会调用as_view()的返回值视图函数view => 调用dispatch()完成请求分发 => 视图类的具体视图方法处理请求 => 返回给前台
总结
1、html常用标签:link、meta、div、span、b、i、a、img、ul、table、form
2、css选择器,css三种布局
div .div #div
盒模型:margin
浮动布局:float
定位布局:position
3、js四种变量,js字符串、数组、对象的操作方法,js可变长参数
let var 没有关键字 const
4、接口的四个核心部分:请求方式,请求地址,请求参数,响应结果
get 取 post 增
长得像返回数据的URL
拼接参数还是数据包参数:key-value
响应状态码,状态信息,数据
5、接口工具:写接口文档的YApi平台,访问接口的Postman工具
接口文档:将接口的四个核心描述成文档
Postman工具:测试接口的请求响应
6、restful接口规范:如何设计url,请求方式代表操作方式,网络状态码及其含义,响应结果
https://api.oldboy.com/v2/users/?limit=3&search=张
get post put(patch) delete
网络状态码:2xx 4xx 5xx
数据:{status,msg,results}
7、基于原生django书写满足restful规范的接口:两个url 对应 一个视图类 完成 十大接口
/api/users/
/api/users/(?P<pk>d+)/
class User(View):
get|post|put|patch|delete方法
8、CBV请求生命周期:as_view()完成路由匹配 => url请求会调用as_view()的返回值视图函数view => 调用dispatch()完成请求分发 => 视图类的具体视图方法处理请求 => 返回给前台
9.
安装drf:pip install djangorestframework
视图类继承drf的APIView: from rest_framework.views import APIView
读懂drf的as_view()方法:返回视图函数view是,局部禁用了csrf认证 - csrf_exempt(view)
请求分发的dispatch(),
在分发执行视图方法前,完成了
二次封装request:self.initialize_request(request, *args, **kwargs)
三大认证:self.initial(request, *args, **kwargs)
在视图方法处理完请求后:
出现异常的处理:self.handle_exception(exc)
二次封装response:self.finalize_response(request, response, *args, **kwargs)