Django DRF APIView Serializer项目配置

DRF APIView

1 DRF框架的 8 个核心功能

1. 认证 （用户登录校验用户名密码或者token是否合法）
2. 权限 (根据不同的用户角色，可以操作不同的表)
3. 限流 （限制接口访问速度）
4. 序列化 （返回json）
5. 分页 （把数据分成一页一页）
6. 版本 （接口版本号，用 v1/v2/v3）
7. 过滤 （筛选所需要的数据）
8. 排序 （对数据进行排序）

1.1 相关包

'''1.序列化相关'''
serializer
ModelSerializer
'''2.DRF视图函数继承'''
APIView  （继承View）
ModelViewSet （继承APIView(mixins)）

2 配置

2.0 配置 项目/settings 全局配置

​

# 过滤器
# 1,安装 django-filter
# 2,注册应用
# 3,配置settings, 在view里配置可过滤的字段
# 4,使用 查询字符串携带过滤信息
REST_FRAMEWORK = {
    # 文档报错： AttributeError: ‘AutoSchema’ object has no attribute ‘get_link’
    # 用下面的设置可以解决
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.AutoSchema',
    # 默认设置是:
    # 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.openapi.AutoSchema',
    # 异常处理器
    # 'EXCEPTION_HANDLER': 'user.utils.exception_handler',
    # Base API policies
    'DEFAULT_RENDERER_CLASSES': [
        'rest_framework.renderers.JSONRenderer',
        'rest_framework.renderers.BrowsableAPIRenderer',
    ],
    'DEFAULT_PARSER_CLASSES': [
        'rest_framework.parsers.JSONParser',
        'rest_framework.parsers.FormParser',
        'rest_framework.parsers.MultiPartParser'
    ],
    # 1.认证器（全局）：用户登录校验用户名密码或者token是否合法
    'DEFAULT_AUTHENTICATION_CLASSES': [
        # 'rest_framework_jwt.authentication.JSONWebTokenAuthentication', # 在 DRF中配置JWT认证
        # 'rest_framework.authentication.SessionAuthentication', # 使用session时的认证器
        # 'rest_framework.authentication.BasicAuthentication' # 提交表单时的认证器
    ],
    # 2.权限配置（全局）： 顺序靠上的严格（根据不同的用户角色，可以操作不同的表）
    'DEFAULT_PERMISSION_CLASSES': [
        # 'rest_framework.permissions.IsAdminUser', # 管理员可以访问
        # 'rest_framework.permissions.IsAuthenticated', # 认证用户可以访问
        # 'rest_framework.permissions.IsAuthenticatedOrReadOnly', # 认证用户可以访问, 否则只能读取
        # 'rest_framework.permissions.AllowAny', # 所有用户都可以访问
    ],
    # 3.限流（防爬虫）
    'DEFAULT_THROTTLE_CLASSES': [
        'rest_framework.throttling.AnonRateThrottle',
        'rest_framework.throttling.UserRateThrottle',
    ],
    # 3.1限流策略
    'DEFAULT_THROTTLE_RATES': {
        'user': '10000/hour',  # 认证用户每小时100次
        'anon': '3000/day',  # 未认证用户每天能访问3次
    },
    'DEFAULT_CONTENT_NEGOTIATION_CLASS':
        'rest_framework.negotiation.DefaultContentNegotiation',
    'DEFAULT_METADATA_CLASS': 'rest_framework.metadata.SimpleMetadata',
    'DEFAULT_VERSIONING_CLASS': None,
    # 4.分页（全局）：全局分页器, 例如 省市区的数据自定义分页器, 不需要分页
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    # 每页返回数量
    'PAGE_SIZE': 10,  # 默认 None
    # 5.过滤器后端
    'DEFAULT_FILTER_BACKENDS': [
        'django_filters.rest_framework.DjangoFilterBackend',
        # 'django_filters.rest_framework.backends.DjangoFilterBackend', 包路径有变化
    ],
    # 5.1过滤排序（全局）：Filtering 过滤排序
    'SEARCH_PARAM': 'search',
    'ORDERING_PARAM': 'ordering',
    'NUM_PROXIES': None,
    # 6.版本控制：Versioning 接口版本控制
    'DEFAULT_VERSION': None,
    'ALLOWED_VERSIONS': None,
    'VERSION_PARAM': 'version',
    # Authentication 认证
    # 未认证用户使用的用户类型
    'UNAUTHENTICATED_USER': 'django.contrib.auth.models.AnonymousUser',
    # 未认证用户使用的Token值
    'UNAUTHENTICATED_TOKEN': None,
    # View configuration
    'VIEW_NAME_FUNCTION': 'rest_framework.views.get_view_name',
    'VIEW_DESCRIPTION_FUNCTION': 'rest_framework.views.get_view_description',
    'NON_FIELD_ERRORS_KEY': 'non_field_errors',
    # Testing
    'TEST_REQUEST_RENDERER_CLASSES': [
        'rest_framework.renderers.MultiPartRenderer',
        'rest_framework.renderers.JSONRenderer'
    ],
    'TEST_REQUEST_DEFAULT_FORMAT': 'multipart',
    # Hyperlink settings
    'URL_FORMAT_OVERRIDE': 'format',
    'FORMAT_SUFFIX_KWARG': 'format',
    'URL_FIELD_NAME': 'url',
    # Encoding
    'UNICODE_JSON': True,
    'COMPACT_JSON': True,
    'STRICT_JSON': True,
    'COERCE_DECIMAL_TO_STRING': True,
    'UPLOADED_FILES_USE_URL': True,
    # Browseable API
    'HTML_SELECT_CUTOFF': 1000,
    'HTML_SELECT_CUTOFF_TEXT': "More than {count} items...",
    # Schemas
    'SCHEMA_COERCE_PATH_PK': True,
    'SCHEMA_COERCE_METHOD_NAMES': {
        'retrieve': 'read',
        'destroy': 'delete'
    },
}

2.1 配置 app/views

class UserView(APIView):
    def get(self, request):
        #展示所有用户信息
        return Response(UserInfoSerializer(User.objects.all(), many=True).data)

    def post(self, request):
        # {
        #     "phone": "13678960987",
        #     "nick_name": "死鬼",
        #     "address": "内蒙古的dd",
        #     "password": "123",
        #     "username": "啊哈哈"
        # }
        # 添加新的用户
        ser = UserSerializer(data=request.data)
        if ser.is_valid():
            ser.save()
            return Response({"msg": "ok", "code": 200})
        else:
            print(ser.errors)
            return Response({"msg": "no", "code": 400})
	
    def put(self, request):	
        
        # {
        #     "username": "啊哈哈"
        # }
        # 路由传pk  然后put提交json数据
        print(request.query_params)
        pk = request.query_params.get('pk')
        print(pk)
        try:
            userinfo = User.objects.get(id=pk)
        except Exception as e:
            return Response(data='用户不存在', status=201)
        # 创建序列化对象，并将要反序列化的数据传递给data构造参数，进而进行验证  局部修改
        ser = UserInfoSerializer(userinfo, data=request.data, partial=True)
        if ser.is_valid():
            ser.save()
            return Response(data=ser.data, status=201)
        return Response(data=ser.errors, status=400)

2.2 配置 app/urls

​

from django.urls import include, path
from rest_framework.routers import SimpleRouter, DefaultRouter
from . import views


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

2.3 配置 app/serializers

class UserInfoSerializer(serializers.Serializer):
    id = serializers.CharField(read_only=True)
    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_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

2.4 配置 app/models

from django.db import models
from django.contrib.auth.models import AbstractUser


# Create your models here.


# 重写user表
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 Meta:
        db_table = 'tb_user'

3 测试接口

3.1 访问路由

#1.查询所有用户
http://192.168.56.100:8888/user/apiview/

#2.put请求修改 id=1的用户
http://192.168.56.100:8888/user/apiview/?pk=5