目录
- Django请求生命周期流程图
- 下载安装
- restful规范
- 序列化和反序列化
- drf快速使用
- CBV源码流程分析
- DRF之APIView和Request对象分析
- Request对象分析
- 序列化器serializer
Django请求生命周期流程图
下载安装
pip3 install djangorestframework
- pycharm下载
- drf安装默认安装的最新版本,如果django版本过低会自动升级到3.x版本
- 版本支持对应关系
restful规范
前后端交互使用api接口
符合某种规范
restful规范
定义:restful定义了web api接口的设计风格,尤其适用于前后端分离的应用模式中
前后端分离的标准
1.保证数据的安全
API与用户的通信协议,总是使用HTTPs协议。
2.用api关键字标识接口
https://api.example.com 尽量将API部署在专用域名(会存在跨域问题)
https://example.org/api/ API很简单
3.多版本共存---》在接口地址中带版本号
URL 如:https://api.example.com/v1/
请求头 跨域时,引发发送多次请求
4.路径,视网络上任何东西都是资源,均使用名词表示(可复数)
https://api.example.com/v1/animals
5.操作资源由请求方式决定:method
GET:从服务器取出资源(一项或多项)
POST:在服务器新建一个资源
PUT:在服务器更新资源(客户端提供改变后的完整资源)
PATCH:在服务器更新资源(客户端提供改变的属性)
DELETE:从服务器删除资源
6.过滤,通过在url上传参的形式传递搜索条件
https://api.example.com/v1/zoos?limit=10:指定返回记录的数量
https://api.example.com/v1/zoos?offset=10:指定返回记录的开始位置
7.状态码
HTTP状态响应码(200、403、404)
json数据自带状态码,服务端自定义的
8.错误处理,应返回错误信息,error当做key。
{
error: "Invalid API key"
}
9.返回结果,针对不同操作,服务器向用户返回的结果应该符合以下规范。
GET /collection:返回资源对象的列表(数组)
GET /collection/resource:返回单个资源对象
POST /collection:返回新生成的资源对象
PUT /collection/resource:返回完整的资源对象
PATCH /collection/resource:返回完整的资源对象
DELETE /collection/resource:返回一个空文档
10.Hypermedia API,RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么。
{"link": {
"rel": "collection https://www.example.com/zoos",
"href": "https://api.example.com/zoos",
"title": "List of zoos",
"type": "application/vnd.yourformat+json"
}}
- HTTP状态响应码
200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。 201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。 202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务) 204 NO CONTENT - [DELETE]:用户删除数据成功。 400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。 401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。 404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。 406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。 410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。 500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。 更多看这里:http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
序列化和反序列化
API接口开发,最核心最常见的一个过程就是序列化,所谓序列化就是把数据转换格式,序列化可以分两个阶段:
- 序列化:把我们语言识别的数据转换成指定的格式提交给别人(前端)
- 比如python中的字典,列表,对象等转json,xml,prop····
- 反序列化:把别人提供的数据转换成我们所需的格式
- 最常见的比如我们使用json模块来对数据进行处理····
在Djangorestframework中的序列化反序列化又是如何?
- 序列化: 在Django中获取到的数据默认是模型对象(QuerySet对象),但是模型对象数据无法直接提供给前端或别的平台使用,我们需要把数据进行序列化,变成字符串或json数据提供给前端或其他平台;
- 反序列化: 前端或其他平台传入数据到后台,比如是json格式字符串,后端需要存入数据库,需要转换成python中的对象,然后处理存入数据库;
drf快速使用
快速写5个接口
使用Django写五个接口得配5个路由,5个视图函数去处理,现在使用drf不需要了,如下:
-查询所有---》get->http://127.0.0.1:8000/books/
-查询一个---》get->http://127.0.0.1:8000/books/1/
-新增一个---》post->http://127.0.0.1:8000/books/ # 在body中带数据
-修改-----》put,patch--->实际编码中,基本都用put,全量修改;patch改部分
http://127.0.0.1:8000/books/1/ body体中传入修改的数据
-删除一个---》delete-->http://127.0.0.1:8000/books/1/
'''所有的接口都是这五个的变形'''
登录本质就是查询一个,注册本质就是新增一个
'''
在我们使用postman的时候,地址严格写,不能缺少/
'''
- models.py
from django.db import models class Book(models.Model): title = models.CharField(max_length=32) price = models.DecimalField(max_digits=5,decimal_places=2) authors = models.CharField(max_length=32)
- views.py
from rest_framework.viewsets import ModelViewSet from app import models from app.serializer import BookSerializer class BookView(ModelViewSet): serializer_class =BookSerializer queryset = models.Book.objects.all()
- serializer.py
from rest_framework.serializers import ModelSerializer from app import models class BookSerializer(ModelSerializer): class Meta: model = models.Book fields = '__all__'
- urls.py
from rest_framework.routers import SimpleRouter from app import views router = SimpleRouter() router.register('books', views.BookView) ''' register(prefix, viewset, base_name) prefix 该视图集的路由前缀 viewset 视图集 base_name 路由名称的前缀 ''' urlpatterns = [ path('admin/', admin.site.urls), ] urlpatterns += router.urls # 千万注意别把注释写到urlpatterns列表中,那样就不是注释了,成字符串了!!!
- 在settings的app中注册
INSTALLED_APPS = [ 'rest_framework' ]
CBV源码流程分析
因为DRF框架里大部分都是基于CBV(视图类)写,所以流程是什么,如何执行需要了解,同时也方便理解APIView,顺便提一嘴APIView也是继承了View ---->
class APIView(View)
这里需要强调一下,CBV路由归根结底还是FBV都是函数的内存地址,比如views.类.as_view()底层仍然是函数的内存地址
- CBV源码执行流程
'''views.py''' from django.views import View from django.http import HttpResponse class TestView(View): def get(self,request): return HttpResponse('get请求') # post csrf认证注释掉就好了 def post(self,request): return HttpResponse('post请求') '''urls.py''' path('test/',views.TestView.as_view())
- 写一个视图类,写了get方法和post方法,来了get请求就走get方法,来了post请求就走post方法,过程如何?且看分析源码执行过程~
'''请求来了在不考虑中间件的情况下,从路由的匹配关系和视图函数来看''' 1、cbv路由写法:path('test/', views.TestView.as_view()) # 第二个参数是函数内存地址,CBV的底层也是FBV,as_view是类的绑定方法,自己的类中没有去父类(View)找,as_view()执行完,也是一个内存地址,内存地址是谁的?是闭包函数view的如下源码 标签:入门,self,request,View,DRF,import,序列化,view From: https://www.cnblogs.com/al6nlee/p/16656097.html