【2020Python修炼记】Django Rest Framework-1-DRF简介+RESTful入门规范
【目录】 day1
1 web 开发模式
2 API接口
3 postman 的使用
4 restful 的规范
5 序列化/ 反序列化
6 Django Rest_Framework
7 drf 的安装和使用
8 cbv源码回顾
学习手册：
1 web 开发模式
在开发Web应用中，有两种应用模式：
1.1 前后端不分离
1.2 前后端分离
2 API接口
- 1=API接口的用处
为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口，用途一目了然，减少双方之间的合作成本。
- 2=API接口 & url 的区别
通过网络，规定了前后台信息交互规则的url链接，也就是前后台信息交互的媒介.
Web API接口和一般的url链接还是有区别的，Web API接口简单概括有下面四大特点
url：长得像返回数据的url链接
请求方式：get、post、put、patch、delete
- 采用get方式请求上方接口
请求参数：json或xml格式的key-value类型数据
- ak：6E823f587c95f0148c19993539b99295
- region：上海
- query：肯德基
- output：json
响应结果：json或xml格式的数据
上方请求参数的output参数值决定了响应数据的格式
数据
# xml格式 https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295®ion=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=xml #json格式 https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295®ion=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=json { "status":0, "message":"ok", "results":[ { "name":"肯德基(罗餐厅)", "location":{ "lat":31.415354, "lng":121.357339 }, "address":"月罗路2380号", "province":"上海市", "city":"上海市", "area":"宝山区", "street_id":"339ed41ae1d6dc320a5cb37c", "telephone":"(021)56761006", "detail":1, "uid":"339ed41ae1d6dc320a5cb37c" } ... ]
3 接口测试工具：Postman
一个测试平台软件
项目测试用例-----保存后可导出测试用例接口json文件
Postman是一款接口调试工具，是一款免费的可视化软件，同时支持各种操作系统平台，是测试接口的首选工具。
Postman可以直接从官网：https://www.getpostman.com/downloads/下载获得，然后进行傻瓜式安装。
- 工作面板
- 简易的get请求
- 简易的post请求
- 案例：请求百度地图接口
4 RESTful API规范
REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征性状态转移）。 它首次出现在2000年Roy Fielding的博士论文中。
RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。
这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。
事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口。
4.1 数据的安全保障
url链接一般都采用https协议进行传输
注：采用https协议，可以提高数据交互过程中的安全性
4.2 接口特征表现
用api关键字标识接口url：
注：看到api字眼，就代表该请求url链接是完成前后台数据交互的
4.3 多数据版本共存
在url链接中标识数据版本
注：url链接中的v1、v2就是不同数据版本的体现（只有在一种数据资源有多版本情况下）
4.4 数据即是资源，均使用名词（可复数）
接口一般都是完成前后台数据的交互，交互的数据我们称之为资源
注：一般提倡用资源的复数形式，在url链接中奖励不要出现操作资源的动词，错误示范：https://api.baidu.com/delete-user
特殊的接口可以出现动词，因为这些接口一般没有一个明确的资源，或是动词就是接口的核心含义
4.5 资源操作由请求方式决定（method）
- 操作资源一般都会涉及到增删改查，我们提供请求方式来标识增删改查动作
- https://api.baidu.com/books - get请求：获取所有书
- https://api.baidu.com/books/1 - get请求：获取主键为1的书
- https://api.baidu.com/books - post请求：新增一本书书
- https://api.baidu.com/books/1 - put请求：整体修改主键为1的书
- https://api.baidu.com/books/1 - patch请求：局部修改主键为1的书
- https://api.baidu.com/books/1 - delete请求：删除主键为1的书
4.6 过滤，通过在url上传参的形式传递搜索条件
- https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
- https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
- https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
- https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
- https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件
4.7 响应状态码
RESTful API响应状态码 与 http协议的响应状态码 是有区别的，
RESTful API响应状态码也可以自定义
4.7.1 正常响应
- 响应状态码2xx
- 200：常规请求
- 201：创建成功
4.7.2 重定向响应
- 响应状态码3xx
- 301：永久重定向
- 302：暂时重定向
4.7.3 客户端异常
- 响应状态码4xx
- 403：请求无权限
- 404：请求路径不存在
- 405：请求方法不存在
4.7.4 服务器异常
- 响应状态码5xx
- 500：服务器异常
4.8 错误处理，应返回错误信息，error当做key
{ error: "无权限操作" }4.9 返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范
GET /collection：返回资源对象的列表（数组） GET /collection/resource：返回单个资源对象 POST /collection：返回新生成的资源对象 PUT /collection/resource：返回完整的资源对象 PATCH /collection/resource：返回完整的资源对象 DELETE /collection/resource：返回一个空文档4.10 需要使用url请求的资源，需要提供访问资源的请求链接
# Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么 { "status": 0, "msg": "ok", "results":[ { "name":"肯德基(罗餐厅)", "img": "https://image.baidu.com/kfc/001.png" } ... ] }比较好的接口返回
# 响应数据要有状态码、状态信息以及数据本身 { "status": 0, "msg": "ok", "results":[ { "name":"肯德基(罗餐厅)", "location":{ "lat":31.415354, "lng":121.357339 }, "address":"月罗路2380号", "province":"上海市", "city":"上海市", "area":"宝山区", "street_id":"339ed41ae1d6dc320a5cb37c", "telephone":"(021)56761006", "detail":1, "uid":"339ed41ae1d6dc320a5cb37c" } ... ] }
5 序列化/ 反序列化
【解说版1】
【序列化】 就是将对象转化方便传输和存储字节序列，例如json.dumps就是序列化（狭义的序列化，将字典转化为json字符串），
这样得到的json字符串不仅直接可以在其他语言使用（跨平台比较好），而且可以在前后端进行传输交互（drf序列化器）
【反序列化】 恰恰相反，而是将字节序列转化为对象，json.loads是将json字符串转化为字典，
是狭义的反序列化（因为在python, 一切皆对象，字典是dict( )），
而在项目中，前端传过来的序列化数据通过反序列化得到对象，进一步可以通过ORM操作，存入数据库。
【解说版2】
api接口开发，最核心最常见的一个过程就是序列化，所谓序列化就是把数据转换格式，序列化可以分两个阶段：
序列化： 把我们识别的数据转换成指定的格式提供给别人。
例如：我们在django中获取到的数据默认是模型对象，但是模型对象数据无法直接提供给前端或别的平台使用，所以我们需要把数据进行序列化，变成字符串或者json数据，提供给别人。
反序列化：把别人提供的数据转换/还原成我们需要的格式。
例如：前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中。
6 Django Rest_Framework
核心思想: 缩减编写api接口的代码
Django REST framework是一个建立在Django基础之上的Web 应用开发框架，可以快速的开发REST API接口应用。在REST framework中，提供了序列化器Serialzier的定义，可以帮助我们简化序列化与反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。REST framework提供了一个API 的Web可视化界面来方便查看测试接口。
官方文档：https://www.django-rest-framework.org/
github: https://github.com/encode/django-rest-framework/tree/master
特点
- 提供了定义序列化器Serializer的方法，可以快速根据 Django ORM 或者其它库自动序列化/反序列化；
- 提供了丰富的类视图、Mixin扩展类，简化视图的编写；
- 丰富的定制层级：函数视图、类视图、视图集合到自动生成 API，满足各种需要；
- 多种身份认证和权限认证方式的支持；[jwt]
- 内置了限流系统；
- 直观的 API web 界面；
- 可扩展性，插件丰富
7 drf 的环境安装与配置
-- 安装drf 后，需要去注册app ，在settings.py的INSTALLED_APPS中添加’rest_framework’。
--安装 drf 插件时，django的版本低于django2.2版本的话，会自动更新到django最新版本，后期可以自己再去重新安装低版本的django。
--因此 drf 插件需要搭配django2.2版本及以上的版本使用
（详情见 ）
8 cbv源码回顾
django Jsonresponse和drf的Response有何区别？
drf的Response 自带结果渲染功能
9 drf基本使用及request源码分析
（详情见-参考）
参考：DRF简介&RESTful规范入门