day03随堂笔记

3.1 查询接口

1.查询所有用户

http://192.168.56.100:8888/user/user/

2.查询id=1的用户

http://192.168.56.100:8888/user/user/1/

3.查询用户名（tom），激活的用户

http://192.168.56.100:8888/user/user/?username=tom&phone=&is_active=true

4.查询所有用户用id 反向排序

http://192.168.56.100:8888/user/user/?ordering=-id

5.查询用户表中第一页，每页显示一条数据

http://192.168.56.100:8888/user/user/?page=1&page_size=1

3.2 自定义认证权限
　　
　　3.2.1 测试全局权限功能
　　　　在浏览器中，打开任意接口，未登录用户只能发送get请求，只有登录用户才能发送post等请求
　　# http://192.168.56.100:8888/user/user/
　　'''syl/settings.py中设置，只有认证用户可以访问, 否则只能读取
　　REST_FRAMEWORK = {
　　　　#2.权限配置（全局）：顺序靠上的严格
　　　　'DEFAULT_PERMISSION_CLASSES': [
　　　　　　'rest_framework.permissions.IsAuthenticatedOrReadOnly', # 认证用户可以访问, 否则只能读取
　　　　],
　　}

3.2.2 测试自定义权限功能
　　
注：自定义权限会覆盖settings.py中配置的全局权限
1.自定义权限（其实应该写到一个单独的文件内进行公用，这里先写到这里进行测试）

自定义权限（局部）

class MyPermission(BasePermission):
　　# has_permission 是用户对这个视图有没有 GET POST PUT PATCH DELETE 权限的分别判断
　　def has_permission(self, request, view):
　　　　print('has_perm')
　　　　# print(view.kwargs.get("pk"), request.user.id)
　　　　"""判断用户对模型有没有访问权"""
　　　　# 任何用户对使用此权限类的视图都有访问权限
　　　　if request.user.is_superuser:
　　　　# 管理员对用户模型有访问权
　　　　　　return True
　　　　elif view.kwargs.get('pk') == str(request.user.id):
　　　　# 携带的id和用户的id相同时有访问权
　　　　　　return True
　　　　return False

　　# has_object_permission 是用户过了 has_permission 判断有权限以后，再判断这个用户有没有对一个具体的对象有没有操作权限

　　def has_object_permission(self, request, view, obj):
　　　　print('has_object_perm')
　　"""获取单个数据时,判断用户对某个数据对象是否有访问权限"""
　　if request.user.id == obj.id:
　　　　return True
　　return False

user/viesws.py视图函数中指定当前视图要用的权限类

class UserViewSet(viewsets.ModelViewSet):
　　# 2.权限：自定义权限类
　　permission_classes = (MyPermission,)

3.3 限流

syl/settings.py中配置限流

http://192.168.56.100:8888/user/apiview/
'''修改syl/settings.py配置限速设置'''
REST_FRAMEWORK = {
　　#3.1 限流策略
　　'DEFAULT_THROTTLE_RATES': {
　　　　'user': '3/hour', # 认证用户每小时10次
　　　　'anon': '3/day', # 未认证用户每天
　　},
}

3.4 序列化

user/serialzers.py

from rest_framework import serializers
from user.models import User

def address_validate(data):

独立校验器

　　# raise serializers.ValidationError('请填写实际地址') # 有错就抛出异常
　　# 没错就返回数据
　　return data
class UserSerializer(serializers.ModelSerializer):

　　# 1.独立校验器：重新设定字段, 替换掉模型中的设定, 重新设定地址的长度为5
　　address = serializers.CharField(max_length=255, min_length=5, validators=[address_validate])

　　# 2.单一字段验证, 验证地址，validate_字段名
　　def validate_address(self, data):
　　　　if data == '测试':
　　　　　　raise serializers.ValidationError('请填写实际地址') # 有错就抛出异常
　　　　return data # 没错就返回结果
　　def validate_phone(self, data):
　　# 不符合手机号格式
　　# raise serializers.ValidationError('手机号格式不正确')
　　model = self.root.Meta.model
　　num = model.objects.filter(phone=data).count()
　　if num > 0:
　　　　raise serializers.ValidationError('手机号已存在')
　　return data

　　# 3.所有属性验证器
　　def validate(self, attrs):
　　　　# attrs：{"username":"zhangsan", "phone":"18538752511", ....}
　　　　# 所有属性验证器
　　　　# self.context 中有request和view上下文
　　　　# self.context['view'].action 可以取到动作
　　　　# attrs 是需要序列化的数据
　　　　# raise serializers.ValidationError('xxx错误') # 有问题报错
　　　　return attrs # 没问题返回数据

　　class Meta:
　　　　model = User # 指定表
　　　　# fields = ('id', ) # 临时添加字段也需要写在这里
　　　　fields = 'all' # 所有字段
　　　　# exclude = ['id'] # 排除 id 字段
　　　　read_only_fields = ('id',) # 指定字段为 read_only,

　　　　# 扩展address： extra_kwargs = {} # 局部替换某些字段的设定, 或者新增设定
　　　　extra_kwargs = {
　　　　　　"address": {
　　　　　　　　"min_length": 5, # 给地址增加最小长度限制
　　　　　　　　"default": '默认测试地址', # 增加默认值
　　}
}

3.5 自定义分页

http://192.168.56.100:8888/user/user/?page=1&page_size=1

user/views.py 中定义自定义分页类

分页（局部）：自定义分页器局部

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

user/views.py 视图函数中使用

class UserViewSet(viewsets.ModelViewSet):
　　# 3.分页：自定义分页器覆盖全局配置
　　pagination_class = PageNum

3.6 过滤和排序

测试url

1.过滤：查询用户名（tom），激活的用户

http://192.168.56.100:8888/user/user/?username=tom&phone=&is_active=true

2.排序：查询所有用户用id 反向排序

http://192.168.56.100:8888/user/user/?ordering=-id

user/views.py 视图函数中配置过滤和排序字段

class UserViewSet(viewsets.ModelViewSet):
　　# 5.过滤：指定过滤方法类, 排序方法类, 一个或多个
　　filter_backends = (DjangoFilterBackend, OrderingFilter) # 同时支持过滤和排序
　　# 5.1指定排序字段, 不设置, 排序功能不起效
　　ordering_fields = ('date_joined', 'id') # ?ordering=-id
　　# 5.2指定过滤字段, 不设置, 过滤功能不起效
　　filter_fields = ('username', 'phone', 'is_active') # ?
username=tom&phone=&is_active=true

前言：
- ModelViewSet 是对APIView封装
- ModelSerializer是对Serializer的封装

1 APIview使用

1.1 在 user/urls.py 中添加路由

urlpatterns = [ 
    path('apiview/', views.UserInfoViewSet.as_view()), 
]

1.2 创建user/serializers.py写序列化器

serializers.ModelSerializer 和 serializers.Serializer field参数说明

''' field参数 ''' 
# 1.read_only 
read_only=True 表示不允许用户自己上传，只能用于api的输出,序列化的时候也不用对这个数据进行验证,序列化返回是有改字段 

# 2.write_only 
write_only=True 表示在更新或创建实例时可以使用该字段，但在序列化返回时不包括该字段。 

# 3.required：该字段是必需的，不能为空 
required=True 反序列化(前端返回数据必须包含此字段)的时候必须提供这个字段、设置False可以不提供 

# 4.allow_null/allow_blank：该字段允许为null/空 
allow_null=True 可以为null 设置False则不能为null 

# 5.label：标签，用于对字段显示设置 
# 6.help_text：对字段进行解释的一段文本，用于提示 
# 7.style：说明字段的类型 
# 8.error_messages：字段出错时，信息提示

创建user/serializers.py写序列化器

from rest_framework import serializers
from users.models import UserInfo

class UserInfoSerializer(serializers.Serializer):
    name = serializers.CharField(min_length=3, max_length=20)            # 显示普通字段
    ut = serializers.CharField(source='ut.type_name', required=False)   # 显示一对多字段名称
    gp = serializers.SerializerMethodField(read_only=True)              # 自定义显示（显示多对多）
    xxx = serializers.CharField(source='name', required=False)          # 也可以自定义显示字段名称
    ut_id = serializers.IntegerField(write_only=True)                   # 一对多关联字段定义（外键约束）

    '''PrimaryKeyRelatedField和StringRelatedField：可以用对 一对多 和 多对多 关联对象序列化'''
    # gp = serializers.PrimaryKeyRelatedField(read_only=True, many=True)
    # gp = serializers.StringRelatedField(read_only=True, many=True)

    class Meta:
        model = UserInfo

    # 自定义显示，多对多，字段
    def get_gp(self, row):
        '''row:传过来的正是 UserInfo表的对象'''
        gp_obj_list = row.gp.all().values('id', 'group')    # 获取用户所有组
        return gp_obj_list
   
# class User(AbstractUser):
# phone = models.CharField('手机号',max_length=20)
# img = models.ImageField(upload_to='user',null=True)
# nick_name = models.CharField('昵称',max_length=20)
# address = models.CharField('地址',max_length=255)

class UserInfoSerializer(serializers.Serializer):

    id = serializers.CharField(read_only=True) # 普通字段，设置id为只读字段，不能修改
	username = serializers.CharField(min_length=3,max_length=20,error_messages={'required': '该字段必填'}) # 显示普通字段
	img = serializers.ImageField(required=False)
	nick_name = serializers.CharField(max_length=20)
	address = serializers.CharField(max_length=255)
	xxx = serializers.SerializerMethodField(read_only=True) # 自定义显示（显示多对
多）

	class Meta:
		model = User
    
    # 自定义显示 多对多 字段
    def get_xxx(self,row):
        '''row: 传过来的正是 User表的对象'''
        users = row.username # 获取用户名
        return users
        # 定义创建语法：ser.save()执行，就会立刻调用create方法用来创建数据
    
    def create(self, validated_data):
        '''
            validated_data: 表单或者vue请求携带的json：
            {"username":"zhangsan","password":"123456"}
        '''
        # https://www.cnblogs.com/xiaonq/p/7978409.html
        return User.objects.create(**validated_data)
        # 定义更新方法
    def update(self, instance, validated_data):
        '''
        instance : 查询的对象

        validated_data : postman提交的json数据
        {"username":"zhangsan","password":"123456"}
        '''
        if validated_data.get('username'):
        	instance.username = validated_data['username']
            instance.save()
            return instance
    
    # 定义单一字段验证的方法
    def validate_username(self, value):
        if value == 'root':
        	raise serializers.ValidationError('不能创建root管理员账号')
    	return value
    
    # 定义多字段验证方法
    def validate(self, attrs):
        print(attrs)
        if attrs.get("username") == 'admin':
        	raise serializers.ValidationError('不能创建admin用户')
        return attrs

1.3 在 user/views.py 中添加视图函数

from user.serializers import UserInfoSerializer
class UserInfoViewSet(APIView):
# 查询用户信息
def get(self, request, *args, **kwargs):
# 一对多、多对多查询都是一样的语法
obj = User.objects.all()
ser = UserInfoSerializer(instance=obj,many=True) # 关联数据多个
# ser = UserInfoSerializer(instance=obj[0]) # 关联数据一个
return Response(ser.data, status=200)
# 创建用户
'''创建用户'''
def post(self,request):
ser = UserInfoSerializer(data=request.data)
# 判断提交数据是否合法
if ser.is_valid():
ser.save()
return Response(data=ser.data, status=201)
return Response(data=ser.errors,status=400)
# 更新用户信息
def put(self, request):
pk = request.query_params.get('pk')
try:
userinfo = User.objects.get(id = pk)
except Exception as e:
return Response(data='用户不存在', status=201)
# 创建序列化对象，并将要反序列化的数据传递给data构造参数，进而进行验证
ser = UserInfoSerializer(userinfo,data=request.data)
if ser.is_valid():
ser.save()
return Response(data=ser.data, status=201)
return Response(data=ser.errors,status=400)

2.序列化正向反相查询

https://www.cnblogs.com/xiaonq/p/10987889.html#i3

3.测试接口

3.1 查询所有用户

3.2 创建用户

3.3 更新用户信息

3.4 限流功能测试

http://192.168.56.100:8888/user/apiview/
'''修改syl/settings.py配置限速设置'''
REST_FRAMEWORK = {
    #3.1 限流策略
    'DEFAULT_THROTTLE_RATES': {
        'user': '3/hour', # 认证用户每小时10次
        'anon': '3/day',
	},
}

4 RESTful风格API

4.1 风格详解

1）REST与技术无关，代表的是一种软件架构风格（REST是Representational State Transfer的简称，中文翻译为“表征状态转移”）

2）REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识

3）所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性

4）对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）

4.2 RESTful API设计规范

4.2.1 API与用户的通信协议

使用HTTPs协议

4.2.2 域名

1）子域名方式

　　　　https://api.example.com 尽量将API部署在专用域名（会存在跨域问题）

　　　　https://www.example.com

2）url方式

　　　　https://example.org

　　　　https://example.org/api/ API很简单

4.2.3 版本

URL，如：https://api.example.com/v1/

请求头跨域时，引发发送多次请求

4.2.4 面向资源编程

路径，视网络上任何东西都是资源，均使用名词表示（可复数）

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

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

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

4.2.5 method

GET：	从服务器取出资源（一项或多项）

POST：	在服务器新建一个资源

PUT：	在服务器更新资源（客户端提供改变后的完整资源）

PATCH：	在服务器更新资源（客户端提供改变的属性）

DELETE： 从服务器删除资源

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

4.2.7 状态码

'''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

4.2.8 错误处理

状态码是4xx时，应返回错误信息，error当做key**

{ ``error: ``"Invalid API key" ``}

4.2.9 返回结果

    针对不同操作，服务器向用户返回的结果应该符合以下规范

　　GET /collection：返回资源对象的列表（数组）

　　GET /collection/resource：返回单个资源对象

　　POST /collection：返回新生成的资源对象

　　PUT /collection/resource：返回完整的资源对象

　　PATCH /collection/resource：返回完整的资源对象

　　DELETE /collection/resource：返回一个空文档

4.2.10 Hypermedia API

RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么

4.3 基于django实现REST framework

urlpatterns = [
    url(r'^users', Users.as_view()),
]

from django.views import View
from django.http import JsonResponse
 
class Users(View):
    def get(self, request, *args, **kwargs):
        result = {
            'status': True,
            'data': 'response data'
        }
        return JsonResponse(result, status=200)
 
    def post(self, request, *args, **kwargs):
        result = {
            'status': True,
            'data': 'response data'
        }
        return JsonResponse(result, status=200)