web开发模式、api接口、api接口测试工具--Postman、restful规范、序列化反序列化、drf快速使用
web开发模式
自己所见过的所有软件,大部分都是web软件,只要通过http、websocket
前后端混合开发
既要写后端(django:python界的web框架),又要写前端(js\css\html + 模板语法(dtl))
dtll米板的西渲染(执行)是在后端执行完--->给到前端(浏览器)--->只有html,css,js
js和dtl混写:js前端浏览器执行 dtl在后端服务器的python解释器中执行
前后端分离(当前主流)
后端人员只写后端,一点前端都不写,只对外提供接口
(django,flask,sanic,fastapi,springboot,gin,beego)
前端人员只写前端,模板语法压根不知道(eg:vue,react)
如果使用前后端分离模式:dtl(模板语法),完全没有用武之地
bom
dom:js操作html--》通过js插入到html中一些表格,div标签
api接口
'''前后端信息交互的媒介'''
前端(pc,小程序,app) --- > 后端
路由 --->视图函数--->返回json格式数据 --->这个东西就称之为api接口
写接口也要有规范--->restful规范
'''为了在团队内部形成共识、防止个人习惯差异引起的混乱,我们需要找到一种大家都觉得很好的接口实现规范,而且这种规范能够让后端写的接口,用途一目了然,减少双方之间的合作成本'''
通过网络,规定了前后台信息交互规则的url链接,也就是前后台信息交互的媒介
api接口四大特点
Web API接口和一般的url链接还是有区别的,Web API接口简单概括有下面四大特点:
- url:长得像返回数据的url链接
https://api.map.baidu.com/place/v2/search
- 请求方式: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"
}
...
]
}
开放的api接口
# 微博 会对外提供接口---》api接口
-你是一个第三方开发者(不是微博的人)--->也利用微博开放的api接口,写出微博的项目
-展示最近微博热点新闻的app---》直接掉开发的api接口
# 别人提供的一些资源,以api接口的形式给你,你直接访问就可以拿到
# 接口的概念很大---》api接口 --->只针对于 http请求返回xml,json数据的这种接口
api接口测试工具--Postman
Postman是一款接口调试工具,是一款免费的可视化软件,同时支持各种操作系统平台,是测试接口的首选工具。
Postman可以直接从官网:https://www.getpostman.com/downloads/下载获得,然后进行傻瓜式安装。
form-data:上传文件
urlencoded:form、ajax表单默认
json:只能用ajax,contentType:application/json
# django中,如果使用form-data或者urlencoded编码----》提交的数据直接从【POST】 取出来
# 如果是json格式编码,从【POST】取不出来,只能从request.body 取出来,json转一下才能用
# postman 就是一个替代浏览器,发送http请求的工具
# 因为用浏览器不能发送post请求,只能用代码写ajax发请求
# 通过postman可以发送任意请求
# collection:可以批量的管理,导入导入很多api接口
-测试数据都带着,不会丢
restful规范
REST全称是Representational State Transfer 表征性状态转移
写api接口,不可能想写成什么样就什么样,有个规范---> 主流认可--->restful规范、
'''RESTful是一种定义Web API接口的设计风格,尤其适用于前后端分离的应用模式中'''
10条规范
1使用https数据交互
url链接一般都采用https协议进行传输
http+tsl/ssl=https 比http更安全,交互是加密传输
-交互用json--->如果很轻易被截获--->明文显示给别人,数据不安全
注:采用https协议,可以提高数据交互过程中的安全性
2 接口地址中带api标识
https://api.baidu.com/books 域名中
https://www.baidu.com/api 地址中
看到api字眼,就代表该请求url链接是完成前后台数据交互的
3 接口地址中标识版本标识
https://api.baidu.com/v1
https://api.baidu.com/v2
为什么要表示版本?
-登陆功能:用户名密码 如果把原来的接口改了---》老app还能用吗?
-升级了app:用户名密码验证码 新写一个接口
4 数据即是资源,均使用名词,不要出现动词
eg:
删除图书接口
-好的:https://api.baidu.com/v1/books
-不好的:https://api.baidu.com/v1/delete-books
# 特殊的接口可以出现动词,因为这些接口一般没有一个明确的资源,或是动词就是接口的核心含义
https://api.baidu.com/place/search
https://api.baidu.com/login
5 资源操作由请求方式决定
操作资源一般都会涉及到增删改查,我们提供请求方式来标识增删改查动作
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的书
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:指定筛选条件
7 响应状态码
-http的响应状态码
-1xx 请求正在处理
-2xx 成功 200 请求成功 201 创建成功
-3xx 重定向 301 和 302 ---》问301和302的区别?一个是临时重定向一个是永久重定向
-4xx 客户端错误 403 和 404 403:没有权限 404:地址不存在
-5xx 服务端错误
-响应中带状态码
{code:100}
8 响应中带错误信息
{
code:999,
msg:'登陆失败'
}
9 针对不同操作,服务器向用户返回的结果应该符合以下规范
- GET /collection:返回资源对象的列表(数组)
-[{name:红楼梦,price:12},{name:西游记,price:12}]
- GET /collection/resource:返回单个资源对象
-{name:西游记,price:12}
- POST /collection:返回新生成的资源对象
-{name:西厢记,price:12}
- PUT /collection/resource:返回完整的资源对象
-{name:西游记,price:12}
- PATCH /collection/resource:返回完整的资源对象
-{name:西游记,price:12}
- DELETE /collection/resource:返回一个空文档
10 响应中带链接地址
比较好的接口返回
# 响应数据要有状态码、状态信息以及数据本身
{
"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"
}
...
]
}
序列化反序列化
# 序列化: 把我们识别的数据转换成指定的格式提供给别人
-python后端:python的对象,字典,列表
-前端:字符串,json格式字符串
-把我们能识别的格式--->转成别人能识别的格式给他
-例如:我们在django中获取到的数据默认是模型对象,但是模型对象数据无法直接提供给前端或别的平台使用,所以我们需要把数据进行序列化,变成字符串或者json数据,提供给别人。
# 反序列化:把别人提供的数据转换/还原成我们需要的格式。
-前端:字符串,json格式字符串 提交给我们
-python后端:把josn格式字符串转成我们能够识别的格式:字典,对象,qs对象
-例如:前端js提供过来的json数据,对于python而言就是字符串,我们需要进行反序列化换成模型类对象,这样我们才能把数据保存到数据库中。
# 前后端分离开发中---》站在后端开发的角度
-序列化----》read(别人读我的数据)---》出---》后端给前端
-反序列化---》wite(别人给我数据--》存到数据库)---》进---》前端给后端
drf快速使用
# djangorestframework 的缩写,它是djagno的一个app(第三方插件),只能用在django框架上
# 可以帮助我们快速的写出符合restful规范的接口
# drf和django的版本有一定的对应关系
-django 4.x (最新)
-drf 版本
-如果是django 2.2.2 drf最新可能不支持(稍微降一下drf版本)
# django 2.2.2(公司用2多) drf 最新
-python 3.8
-django 2.2.2
-drf :3.12.4
# 安装
# 方式一
pip3 install djangorestframework
# 方式二:
在pycharm中点点点