drf快速入门01---REST规范介绍序列化器的基础使用
2024-06-10 22:35:45
一. 基本规范
REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征性状态转移）。 它首次出现在2000年Roy Fielding的博士论文中。RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口。# 抓包工具：fiddler，charles# 10条规范
1 数据的安全保障：url链接一般都采用https协议进行传输 注：采用https协议，可以提高数据交互过程中的安全性
2 接口特征表现，一看就知道是个api接口- 用api关键字标识接口url：- [https://api.baidu.com](https://api.baidu.com/)- https://www.baidu.com/api注：看到api字眼，就代表该请求url链接是完成前后台数据交互的
3 多数据版本共存- 在url链接中标识数据版本- https://api.baidu.com/v1- https://api.baidu.com/v2注：url链接中的v1、v2就是不同数据版本的体现（只有在一种数据资源有多版本情况下）
4 数据即是资源，均使用名词（可复数）- 接口一般都是完成前后台数据的交互，交互的数据我们称之为资源- https://api.baidu.com/users- https://api.baidu.com/books- https://api.baidu.com/book注：一般提倡用资源的复数形式，在url链接中奖励不要出现操作资源的动词，错误示范：https://api.baidu.com/delete-user- 特殊的接口可以出现动词，因为这些接口一般没有一个明确的资源，或是动词就是接口的核心含义- https://api.baidu.com/place/search- https://api.baidu.com/login
5 资源操作由请求方式决定（method）- 操作资源一般都会涉及到增删改查，我们提供请求方式来标识增删改查动作- https://api.baidu.com/books - get请求：获取所有书- https://api.baidu.com/books/1 - get请求：获取主键为1的书- https://api.baidu.com/books - post请求：新增一本书书- https://api.baidu.com/books/1 - put请求：整体修改主键为1的书- https://api.baidu.com/books/1 - patch请求：局部修改主键为1的书- https://api.baidu.com/books/1 - delete请求：删除主键为1的书
6 过滤，通过在url上传参的形式传递搜索条件- https://api.example.com/v1/zoos?limit=10：指定返回记录的数量- https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置- https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数- https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序- https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件7 响应状态码7.1 正常响应- 响应状态码2xx- 200：常规请求- 201：创建成功7.2 重定向响应- 响应状态码3xx- 301：永久重定向- 302：暂时重定向7.3 客户端异常- 响应状态码4xx- 403：请求无权限- 404：请求路径不存在- 405：请求方法不存在7.4 服务器异常- 响应状态码5xx- 500：服务器异常8 错误处理，应返回错误信息，error当做key{error: "无权限操作"}9 返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范GET /collection：返回资源对象的列表（数组）GET /collection/resource：返回单个资源对象POST /collection：返回新生成的资源对象PUT /collection/resource：返回完整的资源对象PATCH /collection/resource：返回完整的资源对象DELETE /collection/resource：返回一个空文档10 需要url请求的资源需要访问资源的请求链接# Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么{"status": 0,"msg": "ok","results":[{"name":"肯德基(罗餐厅)","img": "https://image.baidu.com/kfc/001.png"}...]}二. 序列化组件介绍
0.模型对象就是querySet
1. 序列化:序列化器会把模型对象转换成字典,经过response以后变成json字符串
2. 反序列化:把客户端发送过来的数据,经过request以后变成字典,序列化器可以把字典转成模型
3. 反序列化:完成数据校验功能
4. 序列化哪个字段或者反序列化哪个字段，是自己说的算三. 基于API+serializer的增删查改
1. 注册app
(如果不使用浏览器进行接口查询，就不用注册，因为这个注册就提供了一个浏览器模板，比如用postman测接口，就不用注册)
INSTALLED_APPS = ['rest_framework',
]
2. models
from django.db import models# Create your models here.class Book(models.Model):name = models.CharField(verbose_name='书名', max_length=32)price = models.DecimalField(verbose_name='价格', decimal_places=2, max_digits=5)publish = models.ForeignKey(verbose_name='出版社', to='Publish', on_delete=models.DO_NOTHING)class Publish(models.Model):name = models.CharField(verbose_name='名称', max_length=32)
3.url
from django.urls import path, re_path
from app01 import viewsurlpatterns = [path('text_1/', views.Text1View.as_view()),re_path(r'^text_1/(?P<pk>\d+)/$', views.Text2View.as_view()),
]
view
from rest_framework import status
from rest_framework.views import APIView
from rest_framework.response import Responsefrom . import models
from .sealizer import Text1ViewSerializers, TextModelSerializerclass Text1View(APIView):def get(self, request):# 群查# 1. 获取表模型对象book_queryset = models.Book.objects.all()# 2. 示例化序列化器对象 固定格式如果是序列化多条一定要填一个many=Truetext_book = Text1ViewSerializers(instance=book_queryset, many=True)book_data = {"status": 200,"msg": "ok","data": text_book.data,}return Response(data=book_data, status=status.HTTP_200_OK)def post(self, request):# 新增 request.data--除了GET请求的参数，其他的请求携带数据，都是从request.data这里拿text_book = Text1ViewSerializers(data=request.data)book_data = {"status": 200,"msg": "ok","data": "",}if text_book.is_valid():# 注意如果是serializer的话，必须重写create，不然报错text_book.save()book_data['data'] = text_book.datareturn Response(data=book_data, status=status.HTTP_200_OK)book_data['status'] = 400book_data['msg'] = text_book.errorsreturn Response(data=book_data, status=status.HTTP_400_BAD_REQUEST)class Text2View(APIView):def get(self, request, pk):# 单查# 1. 获取表模型对象book_obj = models.Book.objects.get(pk=pk)# 2. 示例化序列化器对象 固定格式text_book = Text1ViewSerializers(instance=book_obj)book_data = {"status": 200,"msg": "ok","data": text_book.data,}return Response(data=book_data, status=status.HTTP_200_OK)def patch(self, request, pk):# 局部修改 request.data--除了GET请求的参数，其他的请求携带数据，都是从request.data这里拿old_book_obj = models.Book.objects.get(pk=pk)text_book = Text1ViewSerializers(instance=old_book_obj, data=request.data)book_data = {"status": 200,"msg": "ok","data": "",}if text_book.is_valid():# 注意如果是serializer的话，必须重写update，不然报错text_book.save()book_data['data'] = text_book.datareturn Response(data=book_data, status=status.HTTP_200_OK)book_data['status'] = 400book_data['msg'] = text_book.errorsreturn Response(data=book_data, status=status.HTTP_400_BAD_REQUEST)def put(self, request, pk):# 全局修改 request.data--除了GET请求的参数，其他的请求携带数据，都是从request.data这里拿old_book_obj = models.Book.objects.get(pk=pk)text_book = Text1ViewSerializers(instance=old_book_obj, data=request.data)book_data = {"status": 200,"msg": "ok","data": "",}if text_book.is_valid():# 注意如果是serializer的话，必须重写update，不然报错text_book.save()book_data['data'] = text_book.datareturn Response(data=book_data, status=status.HTTP_200_OK)book_data['status'] = 400book_data['msg'] = text_book.errorsreturn Response(data=book_data, status=status.HTTP_400_BAD_REQUEST)def delete(self, request, pk):book_data = {"status": 200,"msg": "ok","data": "",}models.Book.objects.get(pk=pk).delete()return Response(data=book_data, status=status.HTTP_200_OK)sealizer.py
from rest_framework import serializersfrom .views import modelsclass Text1ViewSerializers(serializers.Serializer):name = serializers.CharField()price = serializers.CharField()publish = serializers.CharField()def create(self, validated_data):""":param validated_data: 校验后的数据:return: 必须把创建的对象返回"""book_obj = models.Book.objects.create(**{'name': validated_data.get('name'),'price': float(validated_data.get('price')),'publish_id': int(validated_data.get('publish')),})return book_objdef update(self, instance, validated_data):""":param instance: 老的对象:param validated_data: 校验后的数据:return: 必须把创建的对象返回"""instance.name = validated_data.get('name')instance.price = float(validated_data.get('price'))instance.publish_id = int(validated_data.get('publish'))# 这个save是orm的instance.save()return instance
四. 序列化器属性介绍
read_only 表明该字段仅用于序列化输出，默认False,如果设置成True，postman中可以看到该字段，修改时，不需要传该字段
write_only 表明该字段仅用于反序列化输入，默认False，如果设置成True，postman中看不到该字段，修改时，该字段需要传# 以下的了解
required 表明该字段在反序列化时必须输入，默认True
default 反序列化时使用的默认值
allow_null 表明该字段是否允许传入None，默认False
validators 该字段使用的验证器
error_messages 包含错误编号与错误信息的字典五. 反序列化校验三种方法
1. 局部钩子
class BookSerializer(serializers.Serializer):name=serializers.CharField(max_length=16,min_length=4)price=serializers.CharField()publish=serializers.CharField()def validate_price(self, data): # validate_字段名 接收一个参数# data就是price#如果价格小于10，就校验不通过if float(data)>10:return dataelse:#校验失败，抛异常raise serializers.ValidationError('价格太低')2. 全局钩子
class BookSerializer(serializers.Serializer):name=serializers.CharField(max_length=16,min_length=4)price=serializers.CharField()publish=serializers.CharField()def validate(self, validate_data): # 全局钩子# print(validate_data) 所有校验完的数据，全局钩子是最后一道管卡name=validate_data.get('name')publish=validate_data.get('publish')if name== publish:raise ValidationError('xxxx')else:return validate_data3. 函数校验
def check_name(data):if data.startswith('sb'):raise ValidationError('name不能以sb开头')else:return dataclass BookSerializer(serializers.Serializer):name=serializers.CharField(max_length=16, min_length=4, validators=[check_author,])price=serializers.CharField()publish=serializers.CharField()
drf快速入门01---REST规范介绍序列化器的基础使用相关推荐
- Sers微服务快速入门-01.简介
微服务给我们的第一映像是分布式.架构复杂庞大,部署起来非常麻烦.其实并非如此,不同的架构选型必然带来不同的优点和缺点,没有一劳永逸的方法,配置简单是因为适用的功能场景简单.在项目或产品的实际开发中往往 ...
- 【自动驾驶模拟器AirSim快速入门 | 01】自动驾驶模拟器AirSim实战演练
这是机器未来的第15篇文章 原文首发地址:https://blog.csdn.net/RobotFutures/article/details/125285472 @toc 1. 项目简介 博主基于微 ...
- HTML快速入门-01
HTML是超文本标记语言,由很多预定义的标签组成的,每一种标签有其特殊的含义,这些标签能被浏览器识别并且渲染出不同的显示效果.HTML文档也俗称网页,是网站的重要组成部分. HTML文档结构 < ...
- Python程序设计快速入门01
Python程序设计入门到考试(Day01) 全系列共计6天,十二章.仅作基础入门到期末考试-- 第1章 Python语言概述 1.python的起源 Python由荷兰数学和计算机科学研究学会的[G ...
- SD卡中FAT32文件格式快速入门（图文详细介绍）
说明: MBR :Master Boot Record ( 主引导记录) DBR :DOS Boot Record ( 引导扇区) FAT :File Allocation Table ( 文件分配表 ...
- 分布式链路追踪Jaeger快速入门-01
Logging,Metrics 与 Tracing 关系 同:都是为了提高基础设施和应用程序的可观测性 区别: ---- Logging Metrics Tracing 特点 记录离散的事件 记录可聚 ...
- 3D绘图程序库Pangolin安装以及快速入门，使用教程介绍详细，使用Pangolin绘制点云、直线、轨迹等，设置按钮，进行多窗口、多线程操作，以及Pangolin怎么使用等等
1. Pangolin介绍 常见的3D绘图的程序库有很多,MATLAB.Python的Matplotlib.OpenGL.在Linux上常用的一个3D绘图库是Pangolin,它是基于OpenGL完成 ...
- ETCD快速入门-01 ETCD概述
1.ETCD概述 1.1 ETCD概述 etcd是一个高可用的分布式的键值对存储系统,常用做配置共享和服务发现.由CoreOS公司发起的一个开源项目,受到ZooKeeper与doozer启发而 ...
- docker快速入门01——docker安装与简单应用
1.docker简介 Docker 是一个开源的应用容器引擎,Docker 可以让开发者打包他们的应用以及依赖包到一个轻量级.可移植的容器中,然后发布到任何流行的 Linux 机器上,也可以实现虚拟化 ...
最新文章
- 中国“5G+工业互联网”发展报告
- POJ - 1190 生日蛋糕(dfs+剪枝)
- 基于mysql的主从复制之Mycat简单配置和高可用
- Hacker News热文：请停止学习框架，学习领域驱动设计（DDD）(获500个点赞)
- 技术人员，该如何向业务和产品“砍需求”？
- Django使用问题记录
- SQL Server - 在SQL Server中创建ASSEMBLY
- 华为Mate 30系列发布日期、地点再曝光：9月19日 慕尼黑见？
- 远程多台前置机连接服务器上配置作业，得到作业运行历史记录
- 那些不用上班的老人每天是不是很幸福？
- 中英文对照 —— 英语语法与文法概念
- yolov3损失函数改进_YOLO V3 深度解析 （下）
- CSDN资源分享分红2元，哈哈
- 使用CAFFE训练自己的数据集并单张图片测试的方法
- 通过VScode进行git的版本管理
- linux下添加三菱触摸屏usb驱动,华杰智控带USB口PLC、触摸屏实现远程上下载
- ASM的普通盘转AFD
- 这样设计积分兑换系统，让你的用户“活”起来
- 班农注定落得如此下场
- Halcon模版匹配