04.APIView使用

---

APIView

目录

• APIView
• 一、APIView使用
  • 1. 在user/urls.py中添加路由
  • 2. 创建user/serializer.py写序列化器
  • 3. 在user/views.py中添加视图函数
• 二、测试接口
  • 1. 查询所有用户
  • 2. 创建用户
  • 3. 修改用户信息
  • 4. 限流功能测试

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

一、APIView使用

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

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

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

• serializer.ModelSerializer和serializer.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/serializer.py写序列化器

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
        return User.objects.create(**validated_data)

    # 定义更新方法
    def update(self, instance, validated_data):
        """
        :param instance: 查询的对象
        :param validated_data: postman提交的json数据, 新数据
        :return: instance
        """
        if validated_data.get('username'):
            instance.username = validated_data['username']
        instance.save()
        return instance

    # 定义单一字段验证的方法
    def validate_name(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

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

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)

二、测试接口

1. 查询所有用户

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

2. 创建用户

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

3. 修改用户信息

4. 限流功能测试

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