热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

drf框架概况接口概念resful接口规范Postman接口请求工具drf请求生命周期

drf框架全称:django-rest-framework知识点:难点:源码的解析部分接口一些概念的掌握:接口:联系两个物质之间的媒介,完成信息的交互。在web程序中:联系前台页面

drf框架

全称:django-rest- framework

知识点:

"""
1、接口:什么是接口、restful接口规范
2、CBV生命周期源码-基于restful规范下的CBV接口
3、请求组件、解析组件、响应组件
4、序列化组件(灵魂)
5、三大认证(重点):认证、权限(权限六表)、频率
6、其他组件:过滤、筛选、排序、分页、路由
?
"""


难点:源码的解析部分


接口


一些概念的掌握:

接口:联系两个物质之间的媒介,完成信息的交互。

在web程序中:联系前台页面与后台数据库的媒介。

web接口的组成:

url:长得像是返回数据的url连接

请求的参数:前台按照指定的key提供的数据给后台。

响应数据:后台与数据库交互后将数据反馈给前台

  eg:www.baidu.com

  api.baidu.map/search

restful接口规范

(1)、接口规范:就是为了规定采用不同的后台语言,也能使用同样的接口获取到同样的后台数据。

(2)、如何写接口:接口规范是规范化书写接口的,写接口要写url、响应数据

注:如果将请求参数也纳入考量的范围,那就是在写接口文档。接口文档是提供给前端和运维等参考的依据,

两大部分:

url

(1)、用api关键字标识接口url

api.baidu.com | www.baidu.com/api

(2)、接口数据安全性决定优先选择https协议

(3)、如果一个接口有多版本存在,需要在url中标识体现

api/.baidu.com/v1.... | api.baidu.com/v2/...

 

(4)、接口操作的数据源称之为资源,在url 中一般采用资源负数形式,一个接口可以概括为对资源的多种操作方式。

api.baidu.com/books  |  api.baidu.com/books(pk)   |  api.baidu.com/delete-book

相对比较之下采用books隐藏一些属性,如book的增、删、改、查,不需要另外开设多余的url。

(5)、请求方式有很多种,用一个url处理如何保证不混乱,--通过请求方式标识操作资源的方式

如:

/books get 获取所有
/books post 增加一个(多个)
/books(pk) delete 删除一个
/books(pk) put 整体更新一个
/books(pk) patch 局部更新一个

(6)、资源往往涉及数据的各种操作方式--帅选-排序-限制

api.baidu.com/books/?search=东&ording=-price&limit=3

响应数据

(1)、http请求的响应会有响应状态码,接口用来返回操作的资源数据,可以拥有操作的数据结果的状态码

status  0(操作资源成功)   1(操作资源失败) 2(操作资源成功,但没匹配结果)

注:资源状态码不像http状态码,一般都是后台与前台或客户约定的

(2)、资源的状态码文字提示

  status  ok  “ 账号有误”    ” 用户锁定 “   “用户锁定”

(3)、资源本身

  results

注:删除资源成功一般不做任何数据返回(返回空字符串)

(4)、不能直接返回的资源(子资源、图片、视频等资源),返回该资源的url链接

基于restfu规范的原生Django接口

 

项目的准备工作:

主路由:url.py


from django.conf.urls import url,include
from django.contrib import admin
?
urlpatterns
= [
url(r
^admin/,admin.site.urls),
# 路由的分发
url(r^api/,include(api.urls))
]


api组件的子路由:api/url.py


from django.conf.urls import url
?
from . import views
urlpatterns
= [
url(r
^books/,views.Book.as_view()),
url(r
^books/(?p.*)/$,views.Book.as_view()),
]

 

模型层:model.py


from django.db import models
?
class Book(models.Models):
title
= models.CharField(max_lenght=64)
price
= models.DecimalField(max_digites=5,decimal_places=2)

class Meta:
db_table
= old_boy_book
verbose_name
= 书籍
verbose_name_plural
= verbose_name

def _str_(self):
return 《%s》% self.title

 

后台层:admin.py


from django.contrib import admin
from . import models
admin.site.register(models.Book)

 

 数据库迁移


>: python manage.py makemigrations
>: python manage.py migrrate
>: python manage.py createsuperuser

 

视图层:views.py


from django.http import JsonResponse
from django.views import View
from . import models
# 六大基础接口:获取一个 获取所有 增加一个 删除一个 整体更新一个 局部更新一个
#
十大接口:群增 群删 整体改群改 局部改群改
class Book(View):
def get(self, request, *args, **kwargs):
pk
= kwargs.get(pk)
if not pk: # 群查
# 操作数据库
book_obj_list = models.Book.objects.all()
# 序列化过程
book_list = []
for obj in book_obj_list:
dic
= {}
dic[
title] = obj.title
dic[
price] = obj.price
book_list.append(dic)
# 响应数据
return JsonResponse({
status: 0,
msg: ok,
results: book_list
}, json_dumps_params
={ensure_ascii: False})
else: # 单查
book_dic = models.Book.objects.filter(pk=pk).values(title, price).first()
if book_dic:
return JsonResponse({
status: 0,
msg: ok,
results: book_dic
}, json_dumps_params
={ensure_ascii: False})
return JsonResponse({
status: 2,
msg: 无结果,
}, json_dumps_params
={ensure_ascii: False})
# postman可以完成不同方式的请求:get | post | put ...
# postman发送数据包有三种方式:form-data | urlencoding | json
# 原生django对urlencoding方式数据兼容最好
def post(self, request, *args, **kwargs):
# 前台通过urlencoding方式提交数据
try:
book_obj
= models.Book.objects.create(**request.POST.dict())
if book_obj:
return JsonResponse({
status: 0,
msg: ok,
results: {title: book_obj.title, price: book_obj.price}
}, json_dumps_params
={ensure_ascii: False})
except:
return JsonResponse({
status: 1,
msg: 参数有误,
}, json_dumps_params
={ensure_ascii: False})
return JsonResponse({
status: 2,
msg: 新增失败,
}, json_dumps_params
={ensure_ascii: False})

 

Postman接口工具

官网下载安装:

  https://www.getpostman.com/apps

get请求,携带参数采用Params

post等请求,提交数据包可以采用三种方式:from-date  urlencoding、json

所有的请求都可以携带请求头。

Postman的基本功能:

技术分享图片

 

 接口请求流程:

技术分享图片

 

 响应 示例: 这里会有请求的响应状态码,响应时间,以及响应大小

技术分享图片

 

 DRF框架

目的

  利用DRF框架快速的实现RestAPI接口的设计

是属于序列化的组件,类似一个模块,直接安装即可

安装

>: pip3 install djangorestframework

 

drf框架的封装风格

  比较规矩,规范化,层次比较明确,什么功能直接在相应的模块下导入即可。

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.request import Request
from rest_framework.serializers import Serializer
from rest_framework.settings import APISettings
from rest_framework.filters import SearchFilter
from rest_framework.pagination import PageNumberPagination
from rest_framework.authentication import TokenAuthentication
from rest_framework.permissions import IsAuthenticated
from rest_framework.throttling import SimpleRateThrottle
class Test(APIView):
def get(self, request, *args, **kwargs):
return Response(drf get ok)

 

drf请求生命周期

"""
1) 请求走的是APIView的as_view函数
2) 在APIView的as_view调用父类(django原生)的as_view,还禁用了 csrf 认证
3) 在父类的as_view中dispatch方法请求走的又是APIView的dispatch
4) 完成任务方法交给视图类的请求函数处理,得到请求的响应结果,返回给前台
"""


 请求模块:request对象

源码入口:

APIView类的dispatch方法中:request = self.initialize_request(request, *args, **kwargs)

源码分析

"""
# 二次封装得到def的request对象
request = self.initialize_request(request, *args, **kwargs) 点进去
# 在rest_framework.request.Request实例化方法中
self._request = request 将原生request作为新request的_request属性
# 在rest_framework.request.Request的__getattr__方法中
try:
return getattr(self._request, attr) # 访问属性完全兼容原生request
except AttributeError:
return self.__getattribute__(attr)
"""

重点总结

# 1) drf 对原生request做了二次封装,request._request就是原生request

# 2) 原生request对象的属性和方法都可以被drf的request对象直接访问(兼容)

# 3) drf请求的所有url拼接参数均被解析到query_params中,所有数据包数据都被解析到data中

 

源码重点部分

class Test(APIView):
def get(self, request, *args, **kwargs):
# url拼接的参数
print(request._request.GET) # 二次封装方式
print(request.GET) # 兼容
print(request.query_params) # 拓展
return Response(drf get ok)
def post(self, request, *args, **kwargs):
# 所有请求方式携带的数据包
print(request._request.POST) # 二次封装方式
print(request.POST) # 兼容
print(request.data) # 拓展,兼容性最强,三种数据方式都可以
print(request.query_params)
return Response(drf post ok)

 

渲染模块   


浏览器和Postman请求结果渲染数据的方式不一样


源码入口

APIView类的dispatch方法中:self.respOnse= self.finalize_response(request, response, *args, **kwargs)

源码分析

"""
# 最后解析reponse对象数据
self.respOnse= self.finalize_response(request, response, *args, **kwargs) 点进去
# 拿到运行的解析类的对象们
neg = self.perform_content_negotiation(request, force=True) 点进去
# 获得解析类对象
renderers = self.get_renderers() 点进去
# 从视图类中得到renderer_classes请求类,如何实例化一个个对象形参解析类对象列表
return [renderer() for renderer in self.renderer_classes]
# 重点:self.renderer_classes获取renderer_classes的顺序
# 自己视图类的类属性(局部配置) =>
# APIView类的类属性设置 =>
# 自己配置文件的DEFAULT_RENDERER_CLASSES(全局配置) =>
# drf配置文件的DEFAULT_RENDERER_CLASSES
"""

 

全局配置:所有视图类统一处理,在项目的settings.py中,直接拷贝源码过来放在settings.py即可。

REST_FRAMEWORK = {
# drf提供的渲染类
DEFAULT_RENDERER_CLASSES: [
rest_framework.renderers.JSONRenderer,
rest_framework.renderers.BrowsableAPIRenderer,
],
}

 

局部配置:某一个或一些实体类单独处理,在views.py视图类中提供对应的类属性

class Test(APIView):
def get(self, request, *args, **kwargs):
return Response(drf get ok)
def post(self, request, *args, **kwargs):
return Response(drf post ok)
# 在setting.py中配置REST_FRAMEWORK,完成的是全局配置,所有接口统一处理
#
如果只有部分接口特殊化,可以完成 - 局部配置
from rest_framework.renderers import JSONRenderer
class Test2(APIView):
# 局部配置
renderer_classes = [JSONRenderer]
def get(self, request, *args, **kwargs):
return Response(drf get ok 2)
def post(self, request, *args, **kwargs):
return Response(drf post ok 2)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


推荐阅读
  • Mac OS 升级到11.2.2 Eclipse打不开了,报错Failed to create the Java Virtual Machine
    本文介绍了在Mac OS升级到11.2.2版本后,使用Eclipse打开时出现报错Failed to create the Java Virtual Machine的问题,并提供了解决方法。 ... [详细]
  • 1,关于死锁的理解死锁,我们可以简单的理解为是两个线程同时使用同一资源,两个线程又得不到相应的资源而造成永无相互等待的情况。 2,模拟死锁背景介绍:我们创建一个朋友 ... [详细]
  • 高质量SQL书写的30条建议
    本文提供了30条关于优化SQL的建议,包括避免使用select *,使用具体字段,以及使用limit 1等。这些建议是基于实际开发经验总结出来的,旨在帮助读者优化SQL查询。 ... [详细]
  • CentOS 7部署KVM虚拟化环境之一架构介绍
    本文介绍了CentOS 7部署KVM虚拟化环境的架构,详细解释了虚拟化技术的概念和原理,包括全虚拟化和半虚拟化。同时介绍了虚拟机的概念和虚拟化软件的作用。 ... [详细]
  • 本文介绍了一种解析GRE报文长度的方法,通过分析GRE报文头中的标志位来计算报文长度。具体实现步骤包括获取GRE报文头指针、提取标志位、计算报文长度等。该方法可以帮助用户准确地获取GRE报文的长度信息。 ... [详细]
  • PDF内容编辑的两种小方法,你知道怎么操作吗?
    本文介绍了两种PDF内容编辑的方法:迅捷PDF编辑器和Adobe Acrobat DC。使用迅捷PDF编辑器,用户可以通过选择需要更改的文字内容并设置字体形式、大小和颜色来编辑PDF文件。而使用Adobe Acrobat DC,则可以通过在软件中点击编辑来编辑PDF文件。PDF文件的编辑可以帮助办公人员进行文件内容的修改和定制。 ... [详细]
  • 实现一个通讯录系统,可添加、删除、修改、查找、显示、清空、排序通讯录信息
    本文介绍了如何实现一个通讯录系统,该系统可以实现添加、删除、修改、查找、显示、清空、排序通讯录信息的功能。通过定义结构体LINK和PEOPLE来存储通讯录信息,使用相关函数来实现各项功能。详细介绍了每个功能的实现方法。 ... [详细]
  • 恶意软件分析的最佳编程语言及其应用
    本文介绍了学习恶意软件分析和逆向工程领域时最适合的编程语言,并重点讨论了Python的优点。Python是一种解释型、多用途的语言,具有可读性高、可快速开发、易于学习的特点。作者分享了在本地恶意软件分析中使用Python的经验,包括快速复制恶意软件组件以更好地理解其工作。此外,作者还提到了Python的跨平台优势,使得在不同操作系统上运行代码变得更加方便。 ... [详细]
  • 本文介绍了Foundation框架中一些常用的结构体和类,包括表示范围作用的NSRange结构体的创建方式,处理几何图形的数据类型NSPoint和NSSize,以及由点和大小复合而成的矩形数据类型NSRect。同时还介绍了创建这些数据类型的方法,以及字符串类NSString的使用方法。 ... [详细]
  • php实现用户注册登录界面的方法:1、创建log.php登录主界面;2、设置register.php注册主界面;3、通过mysqli_connect连接数据库并进行相应的数据操作即可。 ... [详细]
  • 本文内容为asp.net微信公众平台开发的目录汇总,包括数据库设计、多层架构框架搭建和入口实现、微信消息封装及反射赋值、关注事件、用户记录、回复文本消息、图文消息、服务搭建(接入)、自定义菜单等。同时提供了示例代码和相关的后台管理功能。内容涵盖了多个方面,适合综合运用。 ... [详细]
  • GetWindowLong函数
    今天在看一个代码里头写了GetWindowLong(hwnd,0),我当时就有点费解,靠,上网搜索函数原型说明,死活找不到第 ... [详细]
  • Metasploit攻击渗透实践
    本文介绍了Metasploit攻击渗透实践的内容和要求,包括主动攻击、针对浏览器和客户端的攻击,以及成功应用辅助模块的实践过程。其中涉及使用Hydra在不知道密码的情况下攻击metsploit2靶机获取密码,以及攻击浏览器中的tomcat服务的具体步骤。同时还讲解了爆破密码的方法和设置攻击目标主机的相关参数。 ... [详细]
  • 本文介绍了使用cacti监控mssql 2005运行资源情况的操作步骤,包括安装必要的工具和驱动,测试mssql的连接,配置监控脚本等。通过php连接mssql来获取SQL 2005性能计算器的值,实现对mssql的监控。详细的操作步骤和代码请参考附件。 ... [详细]
  • 本文整理了315道Python基础题目及答案,帮助读者检验学习成果。文章介绍了学习Python的途径、Python与其他编程语言的对比、解释型和编译型编程语言的简述、Python解释器的种类和特点、位和字节的关系、以及至少5个PEP8规范。对于想要检验自己学习成果的读者,这些题目将是一个不错的选择。请注意,答案在视频中,本文不提供答案。 ... [详细]
author-avatar
mmm3310245179
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有