Django之Apiview和Serializer使用

2024-03-02 21:04:04

Django之Apiview使用

1.Apiview使用

  • ModelViewSet 是对ApiView封装
  • ModelSerializer 是对Serializer封装

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

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

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

  • serializers.ModelSerializer和serializers.Serializer fields参数说明

    #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=Ture 可以为null 设置False则不能为null
# 5. label:标签，用于对字段显示设置
# 6. help_text: 对字段进行解释的一段文本，用于提示
# 7. style：说明字段的类型
# 8. error_messages：字段出错时,信息提示
    • 创建user/serializer.py 写序列化器
    # class User(AbstractUser):
	# phone = models.CharField('手机号',max_length=32)
    # img = models.ImageField(upload_to='user',null=True)
    # nick_name = models.CharField('昵称',max_length=20)
    # address = models.CharField('地址',max_length=255)
class UserInfoSerializer(serializer.Serializer):
    id = serializer.CharField(read_only = True) # 普通字段，设置id为只读，不能修改
    username = serializer.CharFiedl(min_length=3,max_length=20,error_messages={'required':'该字段必填'}) # 显示普通字段
    img = serializers.ImgageField(required=False)
    nick_name = serializer.CharField(max_length=255)
    address = serializers.CharField(max_length=255)
    xxx = serializers.SerializerMethodeField(read_only= True) # 自定义显示(显示多对多)
    class Meta:
        model = User

    # 自定义显示多对多字段
def get_xxx(self,row):
    '''row:传过来的正是 User表的对象'''
    return users
# 定义创建语法：ser.save() 执行，就会立刻调用create方法；用来创建数据
def create(self,validated_data):
    '''validated_data: 表单或者vue请求携带的json：
    {'username':'zhangsan','password':'123,456'}
    '''
    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_name(self,value):
    if value == 'root':
        raise serializers.ValidationErrot('不能创建root管理员账号')
        return value
   
#定义单一字段验证方法
def validate_name(self,value):
    if value=='root':
        raise serializer.ValidationError('不能创建root管理员账号')
    return value

# 定义多字段验证方法

def validate(self,attrs):
    print(attrs)
    if attrs.get('username') == 'admin':
        raise serializer.ValidationError('不能创建admin用户')
    return attrs

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

form user.serializers import UserInfoSerializer
class UserInfoViewSet(APIView):
    # 查询用户信息
    def get(self,request,*args,**kwargs):
        # 一对多、多对多查询都是一样的语法
        obj = User.obj.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='用户不存在'，stutas=201)
    # 创建序列化对象，并将要反序列化的数据传递给data构造参数，进而进行验证
    ser = UserInfoSerializer(userinfo,data=request.data)
    if ser.is_valid():
        ser.save()
        return Response(data=ser.data,status=201)
    return  Responser(data=ser.errors,status=400)

2.测试接口

2.1查询所以用户

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

Django之Apiview和Serializer使用

2.2创建用户

http://192.168.56.100:8888/user/apiview

Django之Apiview和Serializer使用

2.3更新用户信息

http://192.168.56.100:8888/user/apiview/?pk=7

Django之Apiview和Serializer使用

2.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',
},
}
上一篇：Apiview+serallizers


下一篇：APIview使用