- 认证
- 权限
- 限流
- 序列化
- 分页
- 版本
1.1 安装 DjangoRestFramework
1 pip install djangorestframework==3.11.1
2 pip install django-filter==2.3.0 # 过滤器
3 pip install markdown # Markdown support for the browsable API.
1.2 在syl/settings.py中注册
1 INSTALLED_APPS = [
2 'django_filers',
3 'rest_framework',
4 ]
# 过滤器 # 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': '100/hour', # 认证用户每小时100次 'anon': '3/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' }, }
1.4 创建user/serializers.py写序列化器
1 from rest_framework import serializers
2 from user.models import User
3
4 def address_validate(data):
5 # 独立校验器
6 raise serializers.ValidationError('请填写真实地址') # 有错就抛出异常
7 # 没错就返回数据
8 return data
9
10
11 class UserSerializer(serializers.ModelSerializer):
12 # 1.独立校验器,重新设定字段,替换掉模型中的设定,重新设定地址的长度为5
13 address = serializers.CharField(max_length=255, min_length=5, validators=[address_validate])
14
15 # 2.单一字段验证,验证地址
16 def validate_address(self, data):
17 if data == '测试':
18 raise serializers.ValidationError('请填写真实地址') # 有错就抛出异常
19 return data # 没错就返回结果
20
21 def validate_phone(self, data):
22 # 不符合手机号格式
23 raise serializers.ValidationError('手机号格式不正确')
24 model = self.root.Meta.model
25 num = model.objects.filter(phone=data).count()
26 if num > 0:
27 raise serializers.ValidationError('手机号已存在')
28 return data
29
30 # 3.所有属性验证器
31 def validate(self, attrs):
32 # attrs: {"username": "zhangsan", "phone": "154554541", .....}
33 # 所有属性验证器
34 # self.context 中有request和view上下文
35 # self.context['view'].action 可以取到动作
36 # attrs 是需要序列化的数据
37 # raise serializers.ValidationError("xxx错误") # 有问题报错
38 return attrs # 没问题返回数据
39
40 class Meta:
41 model = User
42 # fields = ('id',) # 临时添加字段也需要写在这里
43 fields ="__all__" # 所有字段
44 read_only_fields = ("",) # 指定字段为 read_only,
45
46 # 扩展address: extra_kwargs = {} # 局部替换某些字段的设定,活着新增设定.
47 extra_kwargs = {
48 "address": {
49 "min_length": 5, # 给地址增加 最小长度限制
50 "default":'默认测试地址', # 增加默认值
51 }
52 }
2.DRF认证、权限、限流、 分页、过滤、序列化
2.1 user/urls.py
1 from django.urls import include, path 2 from user import views 3 from rest_framework.routers import SimpleRouter, DefaultRouter 4 5 # 自动生成路由方法,必须使用视图集 6 # router = SimpleRouter() # 没有根路由 /user/ 无法识别 7 router = DefaultRouter() # 有根路由 8 router.register(r'user', views.UserViewSet) # 配置路由 9 10 urlpatterns = [ 11 path('index/', views.index), 12 path('api-auth/', include('rest_framework.uels', namespace='rest_framework')) # 认证地址 13 ] 14 15 urlpatterns += router.urls # 模块地址
2.2user/views.py
1 from django.http import HttpResponse
2 from django_filters.rest_framework import DjangoFilterBackend
3 from rest_framework import viewsets
4 from rest_framework . authentication import BasicAuthentication,SessionAuthentication
5 from rest_framework.decorators import action
6 from rest_framework.filters import OrderingFilter
7 from rest_framework. permissions import AllowAny,IsAdminUser,IsAuthenticated,IsAuthenticated0rReadOnly
8 from rest_framework.response import Response
9 from rest_framework.throttling import UserRateThrottle
10 from rest_framework.pagination import PageNumberPagination
11 from rest_framework .views import APIView
12 from rest_framework .permissions import BasePermission,SAFE_METHODS
13 from user .models import User
14 from user.serializers import UserSerializer,UserUnActiveSerializer
15
16
17 def index(request):
18 # 需要认证才能访问的视图
19 return HttpResponse('hello')
20
21
22 # 分页(布局): 自定义分页器 布局
23 class PageNum(pageNumberPagination):
24 # 查询字符串中代表每页返回数据数量的参数名,默认值:None
25 page_size_query_param = 'page_size'
26 # 查询字符串中代表页码的参数名,默认值:page
27 # page_query_param = 'page'
28 # 一页中最多返回的结果条数
29 max_page_size = 2
30
31
32 # 自定义权限(布局)
33 class MYPermission(BasePermission):
34 def has_permission(self, request, view):
35 print(view.kwargs.get('pk'), request.user.id)
36 """判断用户对模型有没有访问权限"""
37 # 任何用户对使用此权限类的视图都有权限访问
38 print(request)
39 if request.user.is_superuser:
40 # 管理员对用户模型有访问权限
41 return True
42 elif view.kwargs.get('pk') == str(request.user.id):
43 # 携带的id和用户的id相同时有访问权限
44 return True
45 return False
46 def has_object_permission(self, request, view, obj):
47 """获取带个数据时,判断用户对某个数据对象是否有访问权限"""
48 if request.user.id == obj.id:
49 return True
50 return False
1 class UserVIewSet(viewsets.ModelViewSet):
2 """
3 完成产品的增删改查
4 """
5 queryset = User.objects.all()
6 serializer_class = UserSerializer # 优先使用 get_serializer_class 返回的序列化器
7 # # 1.认证:自定义认证类,自定义会覆盖全局配置
8 # authentication_classes = (BasicAuthentication, SessionAuthentication)
9 ## 2.权限:自定义权限类
10 # permission_classes = (MyPermission, )
11
12 # 3.分页:自定义分页器 覆盖全局配置
13 pagination_class = PageNUm
14
15 # 4.限流:自定义限流类
16 throttle_classes = [UserRateThrottle]
17
18 # 5.过滤:指定过滤方法类,排序方法类,一个或多个
19 filter_backends = (DjangoFilterBackend, OrderingFilter) # 同时支持过滤和排序
20 # 5.1 指定排序字段,不设置,排序功能不起效
21 ordering_fields = ('date_joined', 'id') # ?ordering=- id
22 # 5.2指定过滤字段,不设置, 过滤功能不起效
23 filter_fields = ('username','phone','is_active',) # ?username=tom&phone=&is_active=true
24
25
26
27 # 根据不同的请求,获得不同的序列化器
28 def get_serializer_class(self):
29 if self.action == 'unactived':
30 return UserUnActiveSerializer
31 else:
32 return UserSerializer
@action(methods=['get'], detail=False)
def unactived(self, request, *args, **kwargs):
# 获取查询集,过滤出未激活的用户
qs = self.queryset.filter(is_active=False)
# 使用序列化器,序列化查询集,并且是
ser = self.get_serializer(qs,many=True)
return Response(ser.data)