06-REST Framework - API
# Django REST Framework
# 1. REST
- 前后端分离
- API-ApplicationProgrammingInterface
- 为了应付千变万化的前端需求
- REST:RepresataionsStateTrans
- 20000 Fieding博士提出
- RESTful:遵守REST规范的技术设计的软件可以称为RESTful
- REST规范
- URL代表一个资源,一个资源应该是一个名词
- 动作有HTTP的methode方法提供
- URL应该包含版本信息,版本信息也可以放在HTTP协议中
- 过滤信息,使用URL的参数代表过滤
- 返回值: 每一个返回代码都有具体特定含义
- 返回格式:推荐固定具体格式
- DjangoRestFramework(DRF)
- https://q1mi.github.io/Django-REST-framework-documentation/
- 安装:pip install djangorestframework
- 版本问题: version3.7是基于1.xx版本django,之后是2.xx版本django
- django_filter依赖djangorestframework 3.7
- DRF的主要任务
- django-admin startproject TlxyDRF
- python manage.py startapp case01
- 配置settings
- 配置urls
- 创建三个模型:Student,Teacher, ClassRoom
- 创建序列化器
- 创建视图聚合
# 序列化
- 序列化: 把系统运行中的一些实例等转换成一种可直接表示出来的格式,用来保存,传输等
- 反序列化: 序列化的反操作
# 序列化/反序列化-DRF
# 实验步骤
- 创建project DRF2
- 创建app MySer
- settings
# serializer的类型的参数
- read_only: 仅用于序列化输出
- write_only: 反序列化输入
- required:反序列化时必须输入,默认是True
- allow_null: 允许传入None
- validators: 使用验证器
# 创建serializer对象/使用
- 构造方法
Serializer(instance=None, data=empty, **kwarg)
- 反序列化
- 验证
- is_valid:
- 验证数据是否合法,返回boolean
- 在使用从外部传入的数据之前,必须使用此函数进行验证
- 如果验证失败,返回数据错误异常
- validated_data:
- 经过验证后的数据,存入此结构
- 视图
- DRF的试图从处理任务,处理流程等跟Django基本一致
- 此视图基本是django视图的扩展
- Request
- 把请求解析成一个request实例
- 属于DRF的,跟django的HttpRequest不太一样
- 在得到Request之前有一个Parse对传入的数据请求进行解析
- data属性
- 请求数据体,类似于Django的request.POST, request.FILES
- 在DRF中主要指的是Json
- query_params
- 所有传入的关键字
api.tulingxueyuan.com/student/?name='liu'
# 使用案例
name = self.request.query_params.get('name', None)
- user
- 登录后的用户信息都在user中
- 如果没有登录,则是anoymous
- 可以用来判断用户是否登录成功
- Response
- rest_framework.response.Response
- 用Renderer渲染器对返回内容进行渲染
REST_FRAMEWORK = {
'DEFAULT_RENDERER_CLASSES': ( # 默认响应渲染类
'rest_framework.renderers.JSONRenderer', # json渲染器
'rest_framework.renderers.BrowsableAPIRenderer', # 浏览API渲染器
)
}
- 返回的构造方式
- return Response(data, status=None, template_name=None, headers=None, content_type=None)
- data: 返回的数据
- status: 返回的状态码
- 1xx: 信息告知
- 2xx: 成功
- 3xx:重定向
- 4xx: 请求错误
- 5xx: 服务器错误
- 视图类
- APIView
- rest_framework.views.APIView
- 是django中View的子类
- 跟View有不同的地方
- 传入传出数据用的是drf的请求和反馈类
- 会引发并处理APIException
- 在dispatch之前,会进行身份验证,权限检查,流量控制
- 支持的属性有
- authentication_classes: 列表或者元祖,身份验证类
- permisson_classes: 进行权限验证
- throttle_classes:流量控制类
- 对API的访问提供了一些方便
- HTTP-Method + 名词
- 默认对HttpMethod常用方法提供了支持
- API调试工具
- chrome - postman
- firefox - RESTClient
- GenericAPIView
- APIView的子类
- 支持的属性
- queryset:查询结果集
- serializer_class: 视图使用的序列化器
- panination_class: 分页控制器
- filter_backends: 过滤器后端
- lookup_field:查询条件字段,默认为pk
- get_queryset: 返回查询结果集集合,经常需要重写
- get_serializer_class:得到序列化器类
- get_serializer: 得到序列化器
- ListModelMixin
- list(reqeust, *args, **kwargs)
- CreateModelMixin
- create(requst, *args, **kwargs)
- RetrieveModelMixin
- retrieve(...............)
- UpdateModelMixin
- update(..........)
- DestroyModelMixin
- destroy(.......)
- ViewSet
- 把一系列操作打包放入一个类中
- list:GET
- retrieve:GET + id
- destroy:DELETE
- update:UPDATE
- create:POST
06-REST Framework - API的更多相关文章
- Microsoft Win32 to Microsoft .NET Framework API Map
Microsoft Win32 to Microsoft .NET Framework API Map .NET Development (General) Technical Articles ...
- java.lang.NoSuchMethodError: org.apache.curator.framework.api.CreateBuilder.creatingParentsIfNeeded()Lorg/apache/curator/framework/api/ProtectACLCreateModeStatPathAndBytesable;
1 错误信息 java.lang.NoSuchMethodError: org.apache.curator.framework.api.CreateBuilder.creatingParentsIf ...
- Django REST Framework API Guide 01
之前按照REST Framework官方文档提供的简介写了一系列的简单的介绍博客,说白了就是翻译了一下简介,而且翻译的很烂.到真正的生产时,就会发现很鸡肋,连熟悉大概知道rest framework都 ...
- Django Rest Framework API指南
Django Rest Framework API指南 Django Rest Framework 所有API如下: Request 请求 Response 响应 View 视图 Generic vi ...
- Django REST Framework API Guide 06
本节大纲 1.Validators 2.Authentication Validators 在REST框架中处理验证的大多数时间,您将仅仅依赖于缺省字段验证,或在序列化器或字段类上编写显式验证方法.但 ...
- Use Generic Replacements of 1.X Framework API Classes 用泛型替换Framework 1.X版本的API类
第一章,第一节 用泛型替换Framework 1.X版本的API类. 说起来,我是没接触过Framework 1.X版本的程序,12年毕的业(算算时间也一年多了,依旧一事无成,汗),毕业之后到公司实习 ...
- Django REST Framework API Guide 04
本节大纲 1.serializers 1.Serializers Serializers允许复杂的数据,像queryset和模型实例转换成源生的Python数据类型.从而可以更简单的被渲染成JSON, ...
- Django REST Framework API Guide 03
本节大纲 1.Routers 2.Parsers 3.Renderers Routers Usage from rest_framework import routers router = route ...
- Django REST Framework API Guide 02
本节大纲 1.Generic Views 2.ViewSets 1.Generic Views CBV的主要的一个优点就是极大的允许了对于代码的从用.自然,rest framework取其优势,提供 ...
随机推荐
- 【BZOJ3894】 文理分科
Description 文理分科是一件很纠结的事情!(虽然看到这个题目的人肯定都没有纠 结过) 小P所在的班级要进行文理分科.他的班级可以用一个n*m的矩阵进行 描述,每个格子代表一个同学的座位. ...
- 使用 nodejs 和 axios 以及 cherrio 爬取天气预报
安装依赖 引入依赖 发送请求 解析请求的返回值 以下代码可以复制直接运行,获得 7 天的天气预报 const axios = require('axios') const cheerio = requ ...
- [LeetCode]-011-Roman_to_Integer
Given a roman numeral, convert it to an integer. Input is guaranteed to be within the range from 1 t ...
- 用命令行编译运行java文件的乱码问题
之前在写的时候没有遇到过这个问题,用惯了eclipse之后突然用Notepad++就出现乱码了 我在编写的时候 指定Noepad++的编码是 UTF-8编码,然后进入命令行,编译的时候就出现了乱码 然 ...
- EasyUI combobox下拉框添加水平滚动条和垂直滚动条
在EasyUI中combobox组件设置滚动条: 1.垂直滚动条:设置panelHeight属性,默认200,组件的数据过多滚动条自动出现,设置auto,则不出现滚动条. 2.水平滚动条:水平滚动条在 ...
- 读写锁StampedLock的思想
该类是一个读写锁的改进,它的思想是读写锁中读不仅不阻塞读,同时也不应该阻塞写. 读不阻塞写的实现思路: 在读的时候如果发生了写,则应当重读而不是在读的时候直接阻塞写! 因为在读线程非常多而写线程比较少 ...
- Python深度学习读书笔记-4.神经网络入门
神经网络剖析 训练神经网络主要围绕以下四个方面: 层,多个层组合成网络(或模型) 输入数据和相应的目标 损失函数,即用于学习的反馈信号 优化器,决定学习过程如何进行 如图 3-1 所示:多个层 ...
- node服务通过Jenkins上线流程
构建流程 构建服务器: 拉取指定分支代码 构建服务器: 安装依赖 构建服务器: 执行构建 构建服务器: 如果上线流程,则在 git 上创建 tag,供回滚使用 构建服务器:打包 node 服务代码,和 ...
- JVM参数配置详解-包含JDK1.8
堆大小设置 JVM 中最大堆大小有三方面限制:相关操作系统的数据模型(32-bt还是64-bit)限制:系统的可用虚拟内存限制:系统的可用物理内存限制.32位系统下,一般限制在1.5G~2G:6 ...
- 【Python】—— 获取当前运行函数名称和类方法名称
原文出处: python笔记19-获取当前运行函数名称和类方法名称 获取函数名称 1.在函数外部获取函数名称,用.__name__获取 2.函数内部获取当前函数名称,用sys._getframe(). ...