Web应用模式API接口

今日内容

写今日内容之前先放两个网页地址

-http://www.liuqingzheng.top/index2.html
-https://www.cnblogs.com/liuqingzheng

Web应用模式

在开发Web应用中,有两种应用模式第一种就是前后端不分离,第二种就是前后端混合模式:

首先简单来说前后端混合模式就是 -既要写后端(django:python界的web框架),又要写前端(js,css,html + 模板语法(dtl))

前后端不分离

  在前后端不分离的应用模式中,前端页面看到的效果都是由后端控制的,由后端渲染页面或重定向,也就是后端需要控制前端的展示,前端与后端的耦合度很高。

  这种应用模式比较适合纯网页应用,但是当后端对接App时,App可能并不需要后端返回一个HTML网页,而仅仅是数据本身,所以后端原本返回网页的接口不再适用于前端App应用,为了对接App后端还需要在开发一套接口。

前后端不分离

第二种: -前后端分离--》时下主流
-后端人员只写后端,一点前端都不碰,对外提供【接口】 (django,flask,sanic,fastapi,springboot,gin,beego)
-前端人员只写前端,模板语法压根不知道 (vue,react)
-如果使用前后端分离模式:dtl,模板语法,完全没有用武之地

前后端分离
在前后端分离的应用模式中,后端仅返回前端所需的数据,不再渲染HTML页面,不再控制前端的效果。至于前端用户看到什么效果,从后端请求的数据如何加载到前端中,都由前端自己决定,网页有网页的处理方式,App有App的处理方式,但是无论那种前端,所需的数据基本相同,后端仅需要开发一套逻辑对外提供数据即可。

  在前后端分离的应用模式中,前端与后端的耦合度相对较低。

  在前后端分离的应用模式中,我们通常将后端开发的每个视图都称为一个接口或者API,前端通过访问接口来对数据进行增删改查。

前后端分离

API接口

img

首先就是简单介绍一下什么是接口?

首先接口这个概括面太过于广阔每个人和每个人介绍的也不会一样所以接口就看一个人的个人理解(首先我个人对接口也不是能解释得太清楚)
接口泛指实体把自己提供给外界的一种抽象化物(可以为另一实体),用以由内部操作分离出外部沟通方法,使其能被内部修改而不影响外界其他实体与其交互的方式。
接口泛指实体把自己提供给外界的一种抽象化物(可以为另一实体),用以由内部操作分离出外部沟通方法,使其能被内部修改而不影响外界其他实体与其交互的方式。

什么是API接口

API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。API除了有应用“应用程序接口”的意思外,还特指 API的说明文档,也称为帮助文档。
为了在团队内部形成共识、防止个人习惯差异引起的混乱,我们需要找到一种大家都觉得很好的接口实现规范,而且这种规范能够让后端写的接口,用途一目了然,减少双方之间的合作成本。
通过网络,规定了前后台信息交互规则的url链接,也就是前后台信息交互的媒介
# 前后台信息交互的媒介
	前端(pc,小程序,app)-------》后端
  路由---》视图函数--》返回json格式数据  这个东西称之为api接口
  写接口要有规范---》restful规范
# 为了在团队内部形成共识、防止个人习惯差异引起的混乱,我们需要找到一种大家都觉得很好的接口实现规范,而且这种规范能够让后端写的接口,用途一目了然,减少双方之间的合作成本


# 微博 会对外提供接口---》api接口
	-你是一个第三方开发者(不是微博的人)--->也利用微博开放的api接口,写出微博的项目
  -展示最近微博热点新闻的app---》直接掉开发的api接口
  
# 别人提供的一些资源,以api接口的形式给你,你直接访问就可以拿到


# 接口的概念很大---》api接口 --->只针对于 http请求返回xml,json数据的这种接口

api接口测试工具

img

我们来看api接口测试工具postman

Postman是一款接口调试工具,是一款免费的可视化软件,同时支持各种操作系统平台,是测试接口的首选工具。

Postman可以直接从官网:https://www.getpostman.com/downloads/下载获得,然后进行傻瓜式安装。

img

# 后端开发---->开发了很多api接口(可能公司自己用,给第三方用)
# 写完了,对不对,有没有问题---》测试---》测试工具---》postman(免费,收费)  postwomen(仿着postman造了个开源的),。。。。
# 接口测试工具:用法基本一致,以postman为例讲

# 测试工程师---》接口测试工程师


# 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接口
	-测试数据都带着,不会丢
image-20220613113532581

image-20220613113834475

image-20220613114852092

restful规范

img

它首次出现在2000年Roy Fielding的博士论文中。

restful规范主要用于来限制我们编写接口有一个统一,一个规范,主流认可
就只要记住他是一种用来定义API接口的设计风格或者编写风格,尤其适用于前后端分离的应用模式中。
REST全称是Representational State Transfer 表征性状态转移
这种风格的理念认为后端开发任务就是提供数据的,对外提供的是数据资源的访问接口,所以在定义接口时,客户端访问的URL路径就表示这种要操作的数据资源。

事实上,我们可以使用任何一个框架都可以实现符合restful规范的API接口。
# 10条规范
我们见过很多的地址栏中的网址开头有http和https其实简单来说他们的区别就是带s的更为安全一些
	-1 使用https数据交互    http+tsl/ssl=https   比http更安全,交互是加密传输
  		-交互用json---》如果很轻易被截获---》明文显示给别人,数据不安全
-2 接口地址中带api标识
https://api.baidu.com/books   域名中
    	https://www.baidu.com/api     地址中
      -3 接口地址中标识版本标识
    	-https://api.baidu.com/v1
https://api.weibo.com/2/statuses/user_timeline.json
      -登陆功能:用户名密码  如果把原来的接口改了---》老app还能用吗?
      -升级了app:用户名密码验证码  新写一个接口
	-4 数据即是资源,均使用名词,不要出现动词
  		-删除图书接口
    	-好的:https://api.baidu.com/v1/books
      -不好的:https://api.baidu.com/v1/delete-books
     
  - 5 资源操作由请求方式决定
  	-新增图书:https://api.baidu.com/v1/books    post  (查看)
    -删除图书:https://api.baidu.com/v1/books    delete  (删除)
    -修改图书:https://api.baidu.com/v1/books    put  (新增)
    -获取图书:https://api.baidu.com/v1/books    get  (获取)
       - 6 地址中带搜索条件
  	-https://api.example.com/v1/zoos?animal_type_id=1:指定筛选条件
    -https://api.baidu.com/v1/books?name=红楼梦
      

域名补充回顾

https://www.bilibili.com/video/BV18a4y1Y7e9?p=3讲的挺好、

访问 B 站的栗子

www.bilibili.com=== 119.3.70.188你是希望记住前者还是后者

其实就是区域的名字(区域的名字)
每个域名背后都对应一个 IP 地址
虽然每次访问网站都是输入域名,但都是访问这个域名对应 IP 地址的网络服务器来打开网站的
其实就是将一串难以记忆的 IP地址,变成域名,这样就很好记了

响应状态码

HTTP响应状态码 (HTTP Status Code),也属于HTTP协议的一部分,用来标识响应的状态。响应状态码会随着响应消息一起被发送至客户端浏览器,浏览器根据服务器返回的响应状态码,就能知道这次HTTP请求的结果是成功还是失败了。

HTTP 状态码共分为 5种类型:

分类 分类描述
1** 信息响应,服务器收到请求,需要请求者继续执行操作
2** 成功响应,操作被成功接收并处理
3** 重定向,需要进一步的操作以完成请求
4** 客户端响应,请求包含语法错误或无法完成请求
5** 服务器响应,服务器在处理请求的过程中发生了错误

2**成功响应相关

状态码 状态英文名称 中文描述
200 OK 请求成功。一般用于 GET 与 POST 请求
201 Created 已创建。成功请求并创建了新的资源,通常用于 POST 或 PUT 请求

3**重定向相关

状态码 状态英文名称 中文描述
301 Moved Permanently永久移动。 请求的资源已被永久的移动到新URI,返回信息会包括新的URI,浏览器会自动定向到新URI。今后任何新的请求都应使用新的URI代替。
302 Found 临时移动。与301类似。但资源只是临时被移动。客户端应继续使用原有URI
304 Not Modified 未修改。所请求的资源未修改,服务器返回此状态码时,不会返回任何资源(响应消息中不包含响应体)。客户端通常会缓存访问过的资源。

4**客户端响应相关

4** 范围的状态码,表示客户端的请求有非法内容,从而导致这次请求失败。

常见的 4** 类型的状态码如下

状态码 状态英文名称 中文描述
400 Bad Request 1、语义有误,当前请求无法被服务器理解。除非进行修改,否则客户端不应该重复提交这个请求。2、请求参数有误。
401 Unauthorized 当前请求需要用户验证。
403 Forbidden 服务器已经理解请求,但是拒绝执行它。
404 Not Found 请求失败。服务器无法根据客户端的请求找到资源(网页)。
408 Request Timeout 请求超时。服务器等待客户端发送的请求时间过长,超时。

状态码 状态英文名称 中文描述
400 Bad Request 1、语义有误,当前请求无法被服务器理解。除非进行修改,否则客户端不应该重复提交这个请求。2、请求参数有误
401 Unauthorized 当前请求需要用户验证。
403 Forbidden 服务器已经理解请求,但是拒绝执行它
404 Not Found 请求失败。服务器无法根据客户端的请求找到资源(网页)。
408 Request Timeout 请求超时。服务器等待客户端发送的请求时间过长,超时。

5服务端响应相关
5
范围的状态码,表示服务器未能正常处理客户端的请求而出现意外错误。

状态码 状态英文名称 中文描述
500 Internal Server Error 服务器遇到了不知道如何处理的情况。
501 Not Implemented 此请求方法不被服务器支持且无法被处理。只有GET和HEAD是要求服务器支持的,它们必定不会返回此错误代码
503 Service Unavailable 服务器没有准备好处理请求。由于超载或系统维护,服务器暂时的无法处理客户端的请求。
      -响应中带状态码
      	{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 响应中带链接地址
  		 # 只要能说出3,4条即可,面试可能会问,你讲讲resful规范?
  # 只是一个规范,公司可以不按照这个规范来,公司有自己的的,但是大部分还是按它来的

序列化反序列化

# 序列化: 把我们识别的数据转换成指定的格式提供给别人
		-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中点点点



# 快速使用---》以后见到的所有接口,都是这5个和变形
	-增加图书:
  -获取一本图书
  -获取所有图书
  -删除一本图书
  -修改一本图书
 
posted @ 2022-06-14 00:06  文质彬彬赵其辉  阅读(579)  评论(1编辑  收藏  举报