APIView和serializers的使用
1.APIview使⽤
djangorestframework使用:https://www.cnblogs.com/xiaonq/p/10124104.html
DjangoRestFramework使用:https://www.cnblogs.com/xiaonq/p/10987889.html
- ModelViewSet 是对 APIView 封装
- ModelSerializer 是对 Serializer
1.1 在user/urls.py中添加路由
urlpatterns = [
path('apiview/', views.UserInfoViewSet.as_view()),
]
1.2 创建user/serializers.py写序列化器
- serializers.ModelSerializer 和 serializers.Serializer fifield参数说明
''' 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写序列化器
'''
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)
class Meta:
model = User
# 定义创建语法: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 .models import User
from .serializers import UserSerializers
from rest_framework.views import APIView
from rest_framework.response import Response
class UserView(APIView):
# 查询用户信息
def get(self, request, *args, **kwargs):
# ⼀对多、多对多查询都是⼀样的语法
queryset = User.objects.all()
ser = UserSerializers(queryset, many=True) # 多条数据需要many=True
# ser = UserInfoSerializer(instance=obj[0]) # 关联数据⼀个
return Response(ser.data)
# 创建用户
def post(self, request):
data = request.data
ser = UserSerializers(data=data)
try:
# 判断提交数据是否合法
ser.is_valid()
ser.save() # 保存
return Response({'code': 200, 'msg': '添加成功'})
except Exception as e:
# print(e)
print(ser.errors)
return Response({'code': 400, 'msg': '添加失败'})
# 更新⽤户信息
def put(self, request):
pk = request.query_params.get('pk') # 修改数据需要先知道修改那一条数据
try:
userinfo = User.objects.get(id=pk)
except:
return Response({'code': 400, 'msg': '用户不存在'})
# 创建序列化对象,并将要反序列化的数据传递给data构造参数,进而进行验证
ser = UserSerializers(userinfo, data=request.data)
if ser.is_valid():
ser.save()
return Response({'code': 200, 'msg': '修改成功'})
return Response({'code': 400, 'errors': ser.errors})
#删除数据
def delete(self, request):
pk = request.query_params.get('pk')
try:
#删除不需要序列化直接查询后删除
User.objects.filter(id=pk).delete()
return Response({'code': 200, 'msg': '删除成功'})
except:
return Response({'code': 400, 'msg': '删除失败'})
2.序列化正想反相查询
https://www.cnblogs.com/xiaonq/p/10987889.html#i3
3.测试接⼝
3.1 查询所有⽤户
http://192.168.56.100:8888/user/apiview/
3.2 创建⽤户
http://192.168.56.100:8888/user/apiview/
3.3 更新⽤户信息
http://192.168.56.100:8888/user/apiview/?pk=7
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',
},
}
从小白到大神的蜕变~~