其他分享
首页 > 其他分享> > drf_01 web开发模式 api接口 api接口测试工具之postman restful规范 drf快速使用

drf_01 web开发模式 api接口 api接口测试工具之postman restful规范 drf快速使用

作者:互联网

drf_day01

 

web开发模式

# 你见过的所有软件,百分90%,都是web软件,只要通过http,websocket
# web后端---> python 后端开发---》不仅仅是开发网站
-微信,迅雷,百度网盘
-osi七层 mysql,redis: tcp传输层---》应用层http

 

相关知识点:https://www.cnblogs.com/jiqiong/p/16147251.html

 

两种开发方式

前后端混合开发


-之前写的bbs项目,就是混合开发的方式
-既要写后端(django:python界的web框架),又要写前端(js,css,html + 模板语法(dtl))


-大一点公司,如果写前后端混合项目:
-后端人员写后端+模板语法
-因为前端人员写js,css,html:她不懂什么是:模板语法,dtl, jsp,php(模板语法)
-小公司,完全一个人写

-dtl模板的渲染(执行)是在后端执行完---》给到前端(浏览器)--》只有html,css,js
-js和dtl混写:js前端浏览器执行 dtl在后端服务器的python解释器中执行



前后端分离(目前时下主流)


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



-bom
-dom:js操作html--》通过js插入到html中一些表格,div标签

相关知识点:

https://www.cnblogs.com/jiqiong/p/16205126.html


-全栈工程师---》创业型公司---》如果公司敢让你写,你就勇敢大胆的写
-大公司分得很细

 

 

api接口

介绍:

API:应用程序接口(API:Application Program Interface)

-应用程序接口是一组定义、程序及协议的集合,通过 API 接口实现计算机软件之间的相互通信。
-API 的一个主要功能是提供通用功能集。程序员通过调用 API 函数对应用程序进行开发,可以减轻编程任务。
-API 同时也是一种中间件,为各种不同平台提供数据共享。

api 分为四种类型

-远程过程调用(RPC):通过作用在共享数据缓存器上的过程(或任务)实现程序间的通信。

-标准查询语言(SQL):是标准的访问数据的查询语言,通过数据库实现应用程序间的数据共享。

-文件传输:文件传输通过发送格式化文件实现应用程序间数据共享。

-信息交付:指松耦合或紧耦合应用程序间的小型格式化信息,通过程序间的直接通信实现数据共享。

 

举个例子

我们想要知道一周天气如何,如果由自己来实现这个功能很难,因为天气数据只有气象部门才知道。
那该如何知道天气信息呢?
气象部分提供数据API给我们使用,我们只要输入地区就会知道该地区一周的天气情况,但我们并不需要了解这天气预报是如何实现的。

另外,不同系统和编程语言之间的数据通讯往往也采用API形式进行数据交接。

 

 

api接口测试工具

# 后端开发---->开发了很多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转一下才能用

相关知识点:

  https://www.cnblogs.com/jiqiong/p/16303971.html

 

# postman 就是一个替代浏览器,发送http请求的工具
# 因为用浏览器不能发送post请求,只能用代码写ajax发请求
# 通过postman可以发送任意请求

 


   

 

 

collection:

可以批量的管理,导入导出很多api接口  保存后可以一次性测试多个接口


    -测试数据都带着,不会丢

 

restful规范

一套良好的接口规范可以提升工作效率,减少沟通障碍。通常我们都会采用RestfulApi方式来提供接口,使用JSON来传输数据。

Restful是一种定义Web API接口的设计风格,尤其适用于前后端分离的应用模式中

Restful是一种软件架构风格,不是标准。既然不是标准,可以遵守,也可以不遵守。

 

十条规范

-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 
     
       -新增图书:https://api.baidu.com/v1/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=红楼梦
      
   -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:返回资源对象的列表(数组对应的json格式) 
                -[{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 响应中带链接地址

 

序列化反序列化

# 序列化: 把我们识别的数据转换成指定的格式提供给别人
		-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个和变形
    -增加图书:
  -获取一本图书
  -获取所有图书
  -删除一本图书
  -修改一本图书

标签:baidu,接口,---,api,https,com,drf
来源: https://www.cnblogs.com/jiqiong/p/16371700.html