drf 框架

一. DRF框架:

  全称: django-rest framework

  知识点:

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

  

二. 接口

接口:联系两个物质的媒介,完成信息交互
web程序中:联系前台页面与后台数据库的媒介
web接口组成:
    url:长得像返回数据的url链接
    请求参数:前台按照指定的key提供数据给后台
    响应数据:后台与数据库交互后将数据反馈给前台

三. restful接口规范

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

如何写接口:接口规范是 规范化书写接口的,写接口要写 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)

5) 请求方式有多种,用一个url处理如何保证不混乱 - 通过请求方式标识操作资源的方式
    /books         get            获取所有/获取一个
    /books         post           增加一个(多个)
    /books/(pk)    delete         删除一个     params传参
    /books/(pk)    put            整体更新一个
    /books/(pk)    patch          局部更新一个

6) 资源往往涉及数据的各种操作方式 - 筛选、排序、限制
    api.baidu.com/books/?search=西&ordering=-price&limit=3

  响应数据    就是jsonresponse,返回给前端的数据

1) http请求的响应会有响应状态码,接口用来返回操作的资源数据,可以拥有 操作数据结果的 状态码
    status  0(操作资源成功)  1(操作资源失败)  2(操作资源成功,但没匹配结果)
    注:资源状态码不像http状态码,一般都是后台与前台或是客户约定的

2) 资源的状态码文字提示
    status  ok    ‘账号有误‘  ‘密码有误‘  ‘用户锁定‘

3) 资源本身
    results
    注:删除资源成功不做任何数据返回(返回空字符串)

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

四. 基于restful规范的原生django接口

  用规范的接口写之前的django实例

  主路由 urls.py

from django.conf.urls import url,include
from django.contrib import admin

urlpatterns = [
    url(r‘^admin/‘, admin.site.urls),
    url(r‘^app01/‘, include(‘app01.urls‘)),
]

  应用app01下的urls.py

from django.conf.urls import url
from . import views

urlpatterns = [
    url(r‘^books/$‘, views.Book.as_view()),
    url(r‘^books/(?P<pk>.*)/$‘, views.Book.as_view()),
]

  模型层 models.py

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=64)
    price = models.DecimalField(max_digits=5,decimal_places=2)  #生成五位数,小数两位

    class Meta:
        db_table = ‘old_boy_book‘  #设置数据库名
        verbose_name = ‘书籍‘  #设置中文名
        verbose_name_plural = verbose_name  #需要设置这个不然verbose_name会变成书籍s

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

  后台层: 创建登录页面

from django.contrib import admin

from . import models

admin.site.register(models.Book)

  数据库迁移

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

  视图层: views.py

from django.http import JsonResponse
from django.views import View
from . import models

class Book(View):
    #查询
    def get(self,request,*args,**kwargs):
        # print(args)  #无名参数是元组
        print(kwargs)  #有名分组是字典
        pk = kwargs.get(‘pk‘)
        if not pk:  #群查
            #操作数据库查询
            book_obj_list = models.Book.objects.all()
            # print(book_obj_list)
            #序列化数据(把每条数据放在一个字典中,把所有字典数据放在一个list中,数据更好看)
            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).filter().values(‘title‘,‘price‘).first()
            #如果不写first(),还是queryset对象  <QuerySet [{‘title‘: ‘气球‘, ‘price‘: Decimal(‘555.00‘)}]>
            # print(book_dic)  # {‘title‘: ‘气球‘, ‘price‘: Decimal(‘555.00‘)}
            if book_dic:
                return JsonResponse({
                    ‘status‘: 0,
                    ‘msg‘: ‘ok‘,
                    ‘results‘: book_dic
                }, json_dumps_params={‘ensure_ascii‘: False})  # 取消中文转义
            #没有查询到数据
            return JsonResponse({
                ‘status‘: 1,
                ‘msg‘: ‘没有查询到结果‘,
            }, json_dumps_params={‘ensure_ascii‘: False})  # 取消中文转义
   
    #增加
    def post(self,request,*args,**kwargs):
        # print(request.POST.dict())  #{‘title‘: ‘西游记‘, ‘price‘: ‘4.55‘}
        try:
            book_obj = models.Book.objects.create(**request.POST.dict()) #create增加数据
            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‘: 1,
            ‘msg‘: ‘增加错误‘,
        }, json_dumps_params={‘ensure_ascii‘: False})

五. postman接口工具

1.官网下载安装

2.get请求,携带参数采用Params,传值

3.post等请求,在Body里面加数据,提交数据包可以采用三种方式:form-date、urlencoding、json,原生的django对urlencoding方式数据兼容最好

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

DRF框架

  安装

>: pip 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)

  源码分析

# 二次封装得到drf的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中

  使用drf写的get/post请求

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中

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‘)

原文地址:https://www.cnblogs.com/panshao51km-cn/p/11708608.html

时间: 2024-10-06 01:44:58

drf 框架的相关文章

DRF框架之 serializers 序列化组件

1. 什么是序列化,其实在python中我们就学了序列化工具json工具,就是吧信息存为类字典形式 2. DRF框架自带序列化的工具: serializers 3. DRF框架 serializers 分为:第一种 Serializer   第二种 ModelSerializer 第一种用法之 Serializer from django.db import models # Create your models here. class Book(models.Model): nid = mod

DRF框架中其他功能:认证、权限、限流

定义视图时,只要视图继承了APIView或其子类,就可以使用DRF框架的认证.权限和限流功能. 当客户端访问API接口时,DRF框架在调用对应的API接口之前,会依次进行认证.权限和限流的操作. 认证Authentication 权限Permissions 限流Throttling 原文地址:https://www.cnblogs.com/oklizz/p/11290731.html

django drf框架中的user验证以及JWT拓展的介绍

登录注册是几乎所有网站都需要去做的接口,而说到登录,自然也就涉及到验证以及用户登录状态保存,最近用DRF在做的一个关于网上商城的项目中,引入了一个拓展DRF JWT,专门用于做验证和用户状态保存.这个拓展比传统的CSRF更加安全.先来介绍一下JWT认证机制吧! Json web token (JWT), 是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准((RFC 7519).该token被设计为紧凑且安全的,特别适用于分布式站点的单点登录(SSO)场景.JWT的声明一般被用来在身

drf框架--基础

目录 drf框架 导入 什么是接口 restful接口规范 原生Django实现接口 drf框架 Django CBV 和drf CBV对比 响应渲染模块 请求数据解析模块 响应模块 drf框架 导入 http协议 http协议是基于应用层的协议 在发出请求时,需要具备请求首行,请求头,请求体 特点:无状态无连接,且都是客户端先发起请求,服务端再进行响应 wsgi协议 主要就是规定了数据的解析方式,把get之类的http请求解析封装到request里面 在视图函数返回的时候,再把数据打包成htt

drf框架中jwt认证,以及自定义jwt认证

0909自我总结 drf框架中jwt 一.模块的安装 官方:http://getblimp.github.io/django-rest-framework-jwt/ 他是个第三方的开源项目 安装:pip install djangorestframework-jwt 使用自带设定好的jwt from django.urls import path from rest_framework_jwt.views import obtain_jwt_token urlpatterns = [ path(

drf框架中分页组件

0922自我总结 drf框架中分页组件 普通分页(最常用) 自定制分页类 pagination.py from rest_framework.pagination import PageNumberPagination # 普通分页 class CarPageNumberPagination(PageNumberPagination): # 默认一页的条数 page_size = 3 # 用户可以自定义选择一页的条数,但最多显示5条 page_size_query_param = 'page_s

drf框架相关

drf框架: django-rest framework 1.接口:联系两个物质的媒介,完成信息交互 web程序中:联系前台页面与后台数据库的媒介,已完成信息的交互; web接口组成: url:长得像放回数据的url链接 请求参数:前台按照指定的key提供数据给后台 响应数据:后台与数据库交互后将数据反馈给前台 2.restful接口规范 -> 规范化书写接口 定义:为了采用不同的后台语言,也能用同样的接口来获取到同样的数据; 接口文档: 写接口要写 url,响应数据 注:如果将请求参数也纳入考

DRF框架:接口 ,restfui接口规范,基于restful规范的原生Django接口,Postman接口工具

DRF框架 全称:django-rest framework 接口 接口:联系两个物质的媒介,完成信息交互 web程序中:联系前台页面与后台数据库的媒介 web接口组成: url:长得像放回数据的url链接 请求参数:前台按照指定的key提供数据给后台 响应数据:后台与数据库交互后将数据反馈给前台 restful接口规范 接口规范:就是为了采用不同的后台语言,也能使用同样的接口获取到同样的数据 如何写接口:接口规范是 规范化书写接口的,写接口要写 url.响应数据 注:如果将请求参数也纳入考量范

drf框架与postman初始

drf框架 全称:django-rest framework 知识点 """ 1.接口:什么是接口.restful接口规范 2.CBV生命周期源码 - 基于restful规范下的CBV接口 3.请求组件.解析组件.响应组件 4.序列化组件(灵魂) 5.三大认证(重中之重):认证.权限(权限六表).频率 6.其他组件:过滤.筛选.排序.分页.路由 """ # 难点:源码分析 接口 """ 接口:联系两个物质的媒介,完成

drf框架 ----- 接口 cbv生命周期 请求\解析\响应组件 序列化组件 三大认证 其他组件

drf框架 全称: django-rest framework (framework:框架) 理论知识点 大纲 接口 接口: 联系连个物质的媒介, 完成信息交互 web程序中 : 联系前台页面与后台数据库的媒介 web 接口的组成 : url: 统一资源定位符 长得像返回数据的链接 请求参数: 前台按照指定的key 提供数据给后台 响应数据: 后台与数据库交互后将数据反馈给前台 restful接口规范 接口规范:就是为了采用不同的后台语言,也能使用同样的接口获取到同样的数据 如何写接口:接口规范