day02-11-21

最新推荐文章于 2021-01-10 22:48:21 发布

三查田力

最新推荐文章于 2021-01-10 22:48:21 发布

阅读量96

点赞数

分类专栏：后端文章标签： python

本文链接：https://blog.csdn.net/weixin_53138343/article/details/111667607

版权

后端专栏收录该内容

3 篇文章 0 订阅

订阅专栏

1.RESTful风格API

详情查看博客地址：https://www.cnblogs.com/xiaonq/p/10053234.html

1.1 什么是RESTful

REST与技术无关，代表的是一种软件架构风格（REST是Representational State Transfer的简称，中文翻译为“表征状态转移”）
REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识
所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性
对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）

1.web开发本质

对数据库中的表进行增删改查操作
Restful风格就是把所有数据都当做资源，对表的操作就是对资源操作
在url同通过资源名称来指定资源
通过 get/post/put/delete/patch 对资源的操作

2.RESTful API设计规范

1.API与用户的通信协议，总是使用HTTPs协议。
2.域名

# 1）子域名方式
　　https://api.example.com                         尽量将API部署在专用域名（会存在跨域问题）
　　https://www.example.com
# 2）url方式
　　https://example.org
　　https://example.org/api/                        API很简单

3.版本

URL，如：https://api.example.com/v1/
请求头       跨域时，引发发送多次请求

4.面向资源编程：路径，视网络上任何东西都是资源，均使用名词表示（可复数）

https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees

5.method

GET（查询数据）     # 从服务器取出资源（一项或多项）
POST（创建数据）    # 在服务器新建一个资源
PUT（修改数据）     # 在服务器更新资源（客户端提供改变后的完整资源）
PATCH（修改属性）   # 在服务器更新资源（客户端提供改变的属性）
DELETE（删除数据）  # 从服务器删除资源

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：指定筛选条件

状态码

'''1. 2XX请求成功'''
# 200 请求成功，一般用于GET与POST请求
# 201 Created - [POST/PUT/PATCH]：用户新建或修改数据成功。
# 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
# 204 NO CONTENT - [DELETE]：用户删除数据成功。
'''2. 3XX重定向'''
# 301 NO CONTENT - 永久重定向
# 302 NO CONTENT - 临时重定向
'''3. 4XX客户端错误'''
# 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误。
# 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
# 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
# 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录。
# 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
# 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
# 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
'''4. 5XX服务端错误'''
# 500 INTERNAL SERVER ERROR - [*]：服务器内部错误，无法完成请求
# 501 Not Implemented     服务器不支持请求的功能，无法完成请求

更多状态码参考：https://www.runoob.com/http/http-status-codes.html

3.APIView使用

来源

from rest_framework.views import APIView
from rest_framework.response import Response

获取参数

#get 
data = request.query_params
#post
data = request.data

序列化器

class ClassroomSer(serializers.Serializer):
    class_name = serializers.CharField(max_length=20,required=True,label="班级名称")
    address = serializers.CharField(max_length=40,label="地址")
		
    #创建
    def create(self, validated_data):
        return  demomodel.Classroom.objects.create(**validated_data)

		#修改
    def update(self, instance, validated_data):
        instance.class_name = validated_data.get("class_name",instance.class_name)
        instance.address = validated_data.get("address",instance.address)
        instance.save()
        return instance

    #验证单一字段
    # def validate_address(self, attrs):
    #     if attrs != "河南":
    #         raise serializers.ValidationError("教室不在河南")
    #     return attrs

    #验证全部数据
    def validate(self, attrs):
        if attrs.get("address") != "河南":
            raise serializers.ValidationError("教室不在河南")
        return attrs

序列化器可选字段属性

字段	字段构造方式
BooleanField	BooleanField()
NullBooleanField	NullBooleanField()
CharField	CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)
EmailField	EmailField(max_length=None, min_length=None, allow_blank=False)
RegexField	RegexField(regex, max_length=None, min_length=None, allow_blank=False)
SlugField	SlugField(maxlength=50, min_length=None, allow_blank=False) 正则字段，验证正则模式 [a-zA-Z0-9-]+
URLField	URLField(max_length=200, min_length=None, allow_blank=False)
UUIDField	UUIDField(format=‘hex_verbose’) format: 1) `'hex_verbose'` 如`"5ce0e9a5-5ffa-654b-cee0-1238041fb31a"` 2） `'hex'` 如 `"5ce0e9a55ffa654bcee01238041fb31a"` 3）`'int'` - 如: `"123456789012312313134124512351145145114"` 4）`'urn'` 如: `"urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a"`
IPAddressField	IPAddressField(protocol=‘both’, unpack_ipv4=False, **options)
IntegerField	IntegerField(max_value=None, min_value=None)
FloatField	FloatField(max_value=None, min_value=None)
DecimalField	DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None) max_digits: 最多位数 decimal_palces: 小数点位置
DateTimeField	DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None)
DateField	DateField(format=api_settings.DATE_FORMAT, input_formats=None)
TimeField	TimeField(format=api_settings.TIME_FORMAT, input_formats=None)
DurationField	DurationField()
ChoiceField	ChoiceField(choices) choices与Django的用法相同
MultipleChoiceField	MultipleChoiceField(choices)
FileField	FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ImageField	ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ListField	ListField(child=, min_length=None, max_length=None)
DictField	DictField(child=)

选项参数：

参数名称	作用
max_length	最大长度
min_lenght	最小长度
allow_blank	是否允许为空
trim_whitespace	是否截断空白字符
max_value	最小值
min_value	最大值

通用参数：

参数名称	说明
read_only	表明该字段仅用于序列化输出，默认False
write_only	表明该字段仅用于反序列化输入，默认False
required	表明该字段在反序列化时必须输入，默认True
default	反序列化时使用的默认值
allow_null	表明该字段是否允许传入None，默认False
validators	该字段使用的验证器
error_messages	包含错误编号与错误信息的字典
label	用于HTML展示API页面时，显示的字段名称
help_text	用于HTML展示API页面时，显示的字段帮助提示信息

序列化器使用demo

######demoapp/model.py######
from django.db import models
# Create your models here.


from django.db import models

# Create your models here.


class Role(models.Model):
    role_name = models.CharField(max_length=32, unique=True)
    class Meta:
        db_table = "pp_role"

class Classroom(models.Model):
    class_name = models.CharField(max_length=32,verbose_name="班级名称",unique=True)
    address = models.CharField(max_length=32,null=True)

    class Meta:
        db_table = "pp_class"

    def __str__(self):
        return self.class_name

class User(models.Model):
    username = models.CharField(max_length=32,verbose_name="姓名")
    age =models.IntegerField(verbose_name="年龄")
    home = models.CharField(verbose_name="家乡",null=True,max_length=32)
    hight = models.IntegerField(verbose_name="身高",null=True)

    #多对多
    roles = models.ManyToManyField(Role)

    #一对多
    classrooms = models.ForeignKey(Classroom,on_delete=models.CASCADE,null=True,related_name="users")#related_name参数为设置你想查找关键字

    class Meta:
        db_table="pp_user"

#########demoapp/serializer.py###########
from rest_framework import serializers
from demoapp import models as demomodel

class UserSer(serializers.Serializer):
    username = serializers.CharField(max_length=20)
    age = serializers.IntegerField()
    home = serializers.CharField(max_length=20)
    hight = serializers.IntegerField()
    # classrooms = serializers.StringRelatedField(read_only=True)
    # classrooms = serializers.PrimaryKeyRelatedField(read_only=True)

class ClassroomSer(serializers.Serializer):
    class_name = serializers.CharField(max_length=20,required=True,label="班级名称")
    address = serializers.CharField(max_length=40,label="地址")
    user_set = serializers.PrimaryKeyRelatedField(read_only=True,many=True)

    def create(self, validated_data):
        return  demomodel.Classroom.objects.create(**validated_data)


    def update(self, instance, validated_data):
        instance.class_name = validated_data.get("class_name",instance.class_name)
        instance.address = validated_data.get("address",instance.address)
        instance.save()
        return instance

    # def validate_address(self, attrs):
    #     if attrs != "河南":
    #         raise serializers.ValidationError("教室不在河南")
    #     return attrs

    def validate(self, attrs):
        if attrs.get("address") != "河南":
            raise serializers.ValidationError("教室不在河南")
        return attrs

###########demoapp/views.py###########
from django.shortcuts import render
from rest_framework.views import APIView
from rest_framework.response import  Response
from rest_framework.viewsets import ModelViewSet
from demoapp import models as dModel
from demoapp import serializers as dSerializers
# Create your views here.


class ClassRoomView(APIView):
    def get(self,request):
        class_obj = dModel.Classroom.objects.all().first()
        ser = dSerializers.ClassroomSer(class_obj)
        return Response(ser.data)


class UserView(APIView):
    def get(self,request):
        user_obj = dModel.User.objects.get(id=2)
        ser = dSerializers.UserSer(user_obj)
        return Response(ser.data)

APIview使用分页器

from rest_framework.pagination import PageNumberPagination

class PageNum(PageNumberPagination):
    # 查询字符串中代表每页返回数据数量的参数名, 默认值: None
    page_size_query_param = 'max_page'
    # 查询字符串中代表页码的参数名, 有默认值: page
    # page_query_param = 'page'
    # 一页中最多的结果条数
    max_page_size = 10

class ClassRoomView(APIView):
    def get(self,request):
        class_obj = dmodel.Classroom.objects.all()
        paginator = PageNum()
        result_page = paginator.paginate_queryset(class_obj, request)
        ser_obj = dSerializers.ClassroomSer(result_page,many=True)
        return Response(ser_obj.data)

APIview的排序和过滤

from rest_framework.pagination import PageNumberPagination

class ClassRoomView(APIView):
    def get(self,request):
        #过滤
        class_obj = dmodel.Classroom.objects.filter(class_name=request.query_params["class_room"])
        #排序
        class_obj = dmodel.Classroom.objects.all().order_by("age")
        
        ser_obj = dSerializers.ClassroomSer(class_obj,many=True)
        return Response(ser_obj.data)

4.DRF的设置

流量设置
- AnonRateThrottle
限制所有匿名未认证用户，使用IP区分用户。

使用DEFAULT_THROTTLE_RATES['anon'] 来设置频次
- UserRateThrottle
  
  限制认证用户，使用User id 来区分。
  
  使用DEFAULT_THROTTLE_RATES['user'] 来设置频次

REST_FRAMEWORK = {
    'DEFAULT_THROTTLE_CLASSES': (
        'rest_framework.throttling.AnonRateThrottle',
        'rest_framework.throttling.UserRateThrottle'
    ),
    'DEFAULT_THROTTLE_RATES': {
        'anon': '3/day',
        'user': '1000/day'
    }
}