1. 因为接下来的功能中需要使用到登陆功能,所以我们使用django内置admin站点并创建一个管理员.
  1. python manage.py createsuperuser

创建管理员以后,访问admin站点,先修改站点的语言配置

settings.py

访问admin 站点效果:

一. 认证Authentication

可以在配置文件中配置全局默认的认证方案

  1. REST_FRAMEWORK = {
  2. 'DEFAULT_AUTHENTICATION_CLASSES': (
  3. 'rest_framework.authentication.BasicAuthentication', # 基本认证
  4. 'rest_framework.authentication.SessionAuthentication', # session认证
  5. )
  6. }

也可以在每个视图中通过设置authentication_classess属性来设置

  1. from rest_framework.authentication import SessionAuthentication, BasicAuthentication
  2. from rest_framework.views import APIView

  3. class ExampleView(APIView):
  4. authentication_classes = (SessionAuthentication, BasicAuthentication)
  5. ...
  6. 认证失败会有两种可能的返回值:
  7. 401 Unauthorized 未认证
  8. 403 Permission Denied 权限被禁止

二. 权限Permissions

1 权限控制可以限制用户对于视图的访问和对于具体数据对象的访问。

  • 在执行视图的dispatch()方法前,会先进行视图访问权限的判断

  • 在通过get_object()获取具体对象时,会进行模型对象访问权限的判断

使用可以在配置文件中设置默认的权限管理类,如

  1. REST_FRAMEWORK = {
  2. 'DEFAULT_PERMISSION_CLASSES': (
  3. 'rest_framework.permissions.IsAuthenticated',
  4. )
  5. }

如果未指明,则采用如下默认配置

  1. 'DEFAULT_PERMISSION_CLASSES': (
  2. 'rest_framework.permissions.AllowAny',
  3. )

也可以在具体的视图中通过permission_classes属性来设置,如

  1. from rest_framework.permissions import IsAuthenticated
  2. from rest_framework.views import APIView

  3. class ExampleView(APIView):
  4. permission_classes = (IsAuthenticated,)

2 提供的权限

  • AllowAny 允许所有用户

  • IsAuthenticated 仅通过认证的用户

  • IsAdminUser 仅管理员用户

  • IsAuthenticatedOrReadOnly 已经登陆认证的用户可以对数据进行增删改操作,没有登陆认证的只能查看数据。

举例

  1. from rest_framework.authentication import SessionAuthentication
  2. from rest_framework.permissions import IsAuthenticated
  3. from rest_framework.generics import RetrieveAPIView

  4. class BookDetailView(RetrieveAPIView):
  5. queryset = BookInfo.objects.all()
  6. serializer_class = BookInfoSerializer
  7. authentication_classes = [SessionAuthentication]
  8. permission_classes = [IsAuthenticated]

3 自定义权限

如需自定义权限,需继承rest_framework.permissions.BasePermission父类,并实现以下两个任何一个方法或全部

  • .has_permission(self, request, view)

    是否可以访问视图, view表示当前视图对象

  • .has_object_permission(self, request, view, obj)

    是否可以访问数据对象, view表示当前视图, obj为数据对象

例如:

  1. class MyPermission(BasePermission):
  2. def has_object_permission(self, request, view, obj):
  3. """控制对obj对象的访问权限,此案例决绝所有对对象的访问"""
  4. return False

  5. class BookInfoViewSet(ModelViewSet):
  6. queryset = BookInfo.objects.all()
  7. serializer_class = BookInfoSerializer
  8. permission_classes = [IsAuthenticated, MyPermission]

三. 限流Throttling

可以对接口访问的频次进行限制,以减轻服务器压力。

一般用于付费购买次数,投票等场景使用.

1 使用

可以在配置文件中,使用DEFAULT_THROTTLE_CLASSESDEFAULT_THROTTLE_RATES进行全局配置,

  1. REST_FRAMEWORK = {
  2. 'DEFAULT_THROTTLE_CLASSES': (
  3. 'rest_framework.throttling.AnonRateThrottle',
  4. 'rest_framework.throttling.UserRateThrottle'
  5. ),
  6. 'DEFAULT_THROTTLE_RATES': {
  7. 'anon': '100/day',
  8. 'user': '1000/day'
  9. }
  10. }

DEFAULT_THROTTLE_RATES 可以使用 second, minute, hourday来指明周期。

也可以在具体视图中通过throttle_classess属性来配置,如

  1. from rest_framework.throttling import UserRateThrottle
  2. from rest_framework.views import APIView

  3. class ExampleView(APIView):
  4. throttle_classes = (UserRateThrottle,)

2 可选限流类

1) AnonRateThrottle

限制所有匿名未认证用户,使用IP区分用户。

使用DEFAULT_THROTTLE_RATES['anon'] 来设置频次

2)UserRateThrottle

限制认证用户,使用User id 来区分。

使用DEFAULT_THROTTLE_RATES['user'] 来设置频次

3)ScopedRateThrottle

限制用户对于每个视图的访问频次,使用ip或user id。

例如:

  1. class ContactListView(APIView):
  2. throttle_scope = 'contacts'
  3. ...

  4. class ContactDetailView(APIView):
  5. throttle_scope = 'contacts'
  6. ...

  7. class UploadView(APIView):
  8. throttle_scope = 'uploads'
  9. ...
  10. REST_FRAMEWORK = {
  11. 'DEFAULT_THROTTLE_CLASSES': (
  12. 'rest_framework.throttling.ScopedRateThrottle',
  13. ),
  14. 'DEFAULT_THROTTLE_RATES': {
  15. 'contacts': '1000/day',
  16. 'uploads': '20/day'
  17. }
  18. }

实例

  1. from rest_framework.authentication import SessionAuthentication
  2. from rest_framework.permissions import IsAuthenticated
  3. from rest_framework.generics import RetrieveAPIView
  4. from rest_framework.throttling import UserRateThrottle

  5. class BookDetailView(RetrieveAPIView):
  6. queryset = BookInfo.objects.all()
  7. serializer_class = BookInfoSerializer
  8. authentication_classes = [SessionAuthentication]
  9. permission_classes = [IsAuthenticated]
  10. throttle_classes = (UserRateThrottle,)

四. 过滤Filtering

对于列表数据可能需要根据字段进行过滤,我们可以通过添加django-fitlter扩展来增强支持。

  1. pip install django-filter

在配置文件中增加过滤后端的设置:

  1. INSTALLED_APPS = [
  2. ...
  3. 'django_filters', # 需要注册应用,
  4. ]

  5. REST_FRAMEWORK = {
  6. ...
  7. 'DEFAULT_FILTER_BACKENDS': ('django_filters.rest_framework.DjangoFilterBackend',)
  8. }

在视图中添加filter_fields属性,指定可以过滤的字段

  1. class BookListView(ListAPIView):
  2. queryset = BookInfo.objects.all()
  3. serializer_class = BookInfoSerializer
  4. filter_fields = ('btitle', 'bread')

  5. # 127.0.0.1:8000/books/?btitle=西游记

五. 排序

对于列表数据,REST framework提供了OrderingFilter过滤器来帮助我们快速指明数据按照指定字段进行排序。

使用方法:

在类视图中设置filter_backends,使用rest_framework.filters.OrderingFilter过滤器,REST framework会在请求的查询字符串参数中检查是否包含了ordering参数,如果包含了ordering参数,则按照ordering参数指明的排序字段对数据集进行排序。

前端可以传递的ordering参数的可选字段值需要在ordering_fields中指明。

示例:

  1. class BookListView(ListAPIView):
  2. queryset = BookInfo.objects.all()
  3. serializer_class = BookInfoSerializer
  4. filter_fields = ('btitle', 'bread')

  5. # 127.0.0.1:8000/books/?btitle=西游记

六. 分页Pagination

REST framework提供了分页的支持。

我们可以在配置文件中设置全局的分页方式,如:

  1. REST_FRAMEWORK = {
  2. 'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
  3. 'PAGE_SIZE': 100 # 每页数目
  4. }

也可通过自定义Pagination类,来为视图添加不同分页行为。在视图中通过pagination_clas属性来指明。

  1. class LargeResultsSetPagination(PageNumberPagination):
  2. page_size = 1000
  3. page_size_query_param = 'page_size'
  4. max_page_size = 10000
  5. class BookDetailView(RetrieveAPIView):
  6. queryset = BookInfo.objects.all()
  7. serializer_class = BookInfoSerializer
  8. pagination_class = LargeResultsSetPagination

注意:如果在视图内关闭分页功能,只需在视图内设置

  1. pagination_class = None

1 可选分页器

1) PageNumberPagination

前端访问网址形式:

  1. GET http://api.example.org/books/?page=4

可以在子类中定义的属性:

  • page_size 每页数目

  • page_query_param 前端发送的页数关键字名,默认为"page"

  • page_size_query_param 前端发送的每页数目关键字名,默认为None

  • max_page_size 前端最多能设置的每页数量

  1. from rest_framework.pagination import PageNumberPagination

  2. class StandardPageNumberPagination(PageNumberPagination):
  3. page_size_query_param = 'page_size'
  4. max_page_size = 10

  5. class BookListView(ListAPIView):
  6. queryset = BookInfo.objects.all().order_by('id')
  7. serializer_class = BookInfoSerializer
  8. pagination_class = StandardPageNumberPagination

  9. # 127.0.0.1/books/?page=1&page_size=2

LimitOffsetPagination

前端访问网址形式:

  1. GET http://api.example.org/books/?limit=100&offset=400

可以在子类中定义的属性:

  • default_limit 默认限制,默认值与PAGE_SIZE设置一直

  • limit_query_param limit参数名,默认'limit'

  • offset_query_param offset参数名,默认'offset'

  • max_limit 最大limit限制,默认None

  1. from rest_framework.pagination import LimitOffsetPagination

  2. class BookListView(ListAPIView):
  3. queryset = BookInfo.objects.all().order_by('id')
  4. serializer_class = BookInfoSerializer
  5. pagination_class = LimitOffsetPagination

  6. # 127.0.0.1:8000/books/?offset=3&limit=2

七. 异常处理 Exceptions

REST framework提供了异常处理,我们可以自定义异常处理函数。

  1. from rest_framework.views import exception_handler

  2. def custom_exception_handler(exc, context):
  3. # 先调用REST framework默认的异常处理方法获得标准错误响应对象
  4. response = exception_handler(exc, context)

  5. # 在此处补充自定义的异常处理
  6. if response is not None:
  7. response.data['status_code'] = response.status_code

  8. return response

在配置文件中声明自定义的异常处理

  1. REST_FRAMEWORK = {
  2. 'EXCEPTION_HANDLER': 'my_project.my_app.utils.custom_exception_handler'
  3. }
  4. 如果未声明,会采用默认的方式,如下
  5.  
  6. REST_FRAMEWORK = {
  7. 'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler'
  8. } 

例如:

补充上处理关于数据库的异常

  1. from rest_framework.views import exception_handler as drf_exception_handler
  2. from rest_framework import status
  3. from django.db import DatabaseError

  4. def exception_handler(exc, context):
  5. response = drf_exception_handler(exc, context)

  6. if response is None:
  7. view = context['view']
  8. if isinstance(exc, DatabaseError):
  9. print('[%s]: %s' % (view, exc))
  10. response = Response({'detail': '服务器内部错误'}, status=status.HTTP_507_INSUFFICIENT_STORAGE)

  11. return response

REST framework定义的异常

  • APIException 所有异常的父类

  • ParseError 解析错误

  • AuthenticationFailed 认证失败

  • NotAuthenticated 尚未认证

  • PermissionDenied 权限决绝

  • NotFound 未找到

  • MethodNotAllowed 请求方式不支持

  • NotAcceptable 要获取的数据格式不支持

  • Throttled 超过限流次数

  • ValidationError 校验失败

八. 自动生成接口文档

REST framework可以自动帮助我们生成接口文档。

接口文档以网页的方式呈现。

自动接口文档能生成的是继承自APIView及其子类的视图。

1. 安装依赖

REST framewrok生成接口文档需要coreapi库的支持。

  1. pip install coreapi

2. 设置接口文档访问路径

在总路由中添加接口文档路径。

文档路由对应的视图配置为rest_framework.documentation.include_docs_urls

参数title为接口文档网站的标题。

  1. from rest_framework.documentation import include_docs_urls

  2. urlpatterns = [
  3. ...
  4. path('docs/', include_docs_urls(title='站点页面标题'))
  5. ]

3. 文档描述说明的定义位置

1) 单一方法的视图,可直接使用类视图的文档字符串,如

  1. class BookListView(generics.ListAPIView):
  2. """
  3. 返回所有图书信息.
  4. """

  

2)包含多个方法的视图,在类视图的文档字符串中,分开方法定义,如

  1. class BookListCreateView(generics.ListCreateAPIView):
  2. """
  3. get:
  4. 返回所有图书信息.
  5. post:
  6. 新建图书.
  7. """

3)对于视图集ViewSet,仍在类视图的文档字符串中封开定义,但是应使用action名称区分,如

  1. class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
  2. """
  3. list:
  4. 返回图书列表数据
  5. retrieve:
  6. 返回图书详情数据
  7. latest:
  8. 返回最新的图书数据
  9. read:
  10. 修改图书的阅读量
  11. """

4. 访问接口文档网页

浏览器访问 127.0.0.1:8000/docs/,即可看到自动生成的接口文档。

两点说明:

1) 视图集ViewSet中的retrieve名称,在接口文档网站中叫做read

2)参数的Description需要在模型类或序列化器类的字段中以help_text选项定义,如:

  1. class BookInfo(models.Model):
  2. ...
  3. bread = models.IntegerField(default=0, verbose_name='阅读量', help_text='阅读量')
  4. ...

  5. class BookReadSerializer(serializers.ModelSerializer):
  6. class Meta:
  7. model = BookInfo
  8. fields = ('bread', )
  9. extra_kwargs = {
  10. 'bread': {
  11. 'required': True,
  12. 'help_text': '阅读量'
  13. }
  14. }

九. Xadmin

xadmin是Django的第三方扩展,可是使Django的admin站点使用更方便。

文档:https://xadmin.readthedocs.io/en/latest/index.html

1. 安装

通过如下命令安装xadmin的最新版

  1. pip install https://codeload.github.com/sshwsfc/xadmin/zip/django2

在配置文件中注册如下应用

  1. INSTALLED_APPS = [
  2. ...
  3. 'xadmin',
  4. 'crispy_forms',
  5. 'reversion',
  6. ...
  7. ]
  1. # 修改使用中文界面
  1. LANGUAGE_CODE = 'zh-Hans'
  1. # 修改时区
  1. TIME_ZONE = 'Asia/Shanghai'

xadmin有建立自己的数据库模型类,需要进行数据库迁移

  1. python manage.py makemigrations
  2. python manage.py migrate

在总路由中添加xadmin的路由信息

  1. import xadmin
  2. xadmin.autodiscover()
  1. # version模块自动注册需要版本控制的 Model
  1. from xadmin.plugins import xversion
  2. xversion.register_models()

  3. urlpatterns = [
  4. path(r'xadmin/', xadmin.site.urls)
  5. ]

创建超级用户

  1. python manage.py createsuperuser

2. 使用

  • xadmin不再使用Django的admin.py,而是需要编写代码在adminx.py文件中。

  • xadmin的站点管理类不用继承admin.ModelAdmin,而是直接继承object即可。

例如:在子应用中创建adminx.py文件。

1) 站点的全局配置

  1. import xadmin
  2. from xadmin import views

  3. class BaseSetting(object):
  4. """xadmin的基本配置"""
  5. enable_themes = True # 开启主题切换功能
  6. use_bootswatch = True

  7. xadmin.site.register(views.BaseAdminView, BaseSetting)

  8. class GlobalSettings(object):
  9. """xadmin的全局配置"""
  10. site_title = "路飞学城" # 设置站点标题
  11. site_footer = "路飞学城有限公司" # 设置站点的页脚
  12. menu_style = "accordion" # 设置菜单折叠

  13. xadmin.site.register(views.CommAdminView, GlobalSettings)

2)站点Model管理

xadmin可以使用的页面样式控制基本与Django原生的admin一直。

  • list_display 控制列表展示的字段

    1. list_display = ['id', 'btitle', 'bread', 'bcomment']
  • search_fields 控制可以通过搜索框搜索的字段名称,xadmin使用的是模糊查询

    1. search_fields = ['id','btitle']  
  • list_filter 可以进行过滤操作的列,对于分类、性别、状态

    1. list_filter = ['is_delete']
  • ordering 默认排序的字段

  • readonly_fields 在编辑页面的只读字段

  • exclude 在编辑页面隐藏的字段

  • list_editable 在列表页可以快速直接编辑的字段

  • show_detail_fields 在列表页提供快速显示详情信息

  • refresh_times 指定列表页的定时刷新

    1. refresh_times = [5, 10,30,60] # 设置允许后端管理人员按多长时间(秒)刷新页面
  • list_export 控制列表页导出数据的可选格式

    1. list_export = ('xls', 'xml', 'json') list_export设置为None来禁用数据导出功能
    2. list_export_fields = ('id', 'btitle', 'bpub_date')
  • show_bookmarks 控制是否显示书签功能

    1. show_bookmarks = True
  • data_charts 控制显示图表的样式

    1. data_charts = {
    2. "order_amount": {
    3. 'title': '图书发布日期表',
    4. "x-field": "bpub_date",
    5. "y-field": ('btitle',),
    6. "order": ('id',)
    7. },
    8. # 支持生成多个不同的图表
    9. # "order_amount": {
    10. # 'title': '图书发布日期表',
    11. # "x-field": "bpub_date",
    12. # "y-field": ('btitle',),
    13. # "order": ('id',)
    14. # },
    15. }
    • title 控制图标名称

    • x-field 控制x轴字段

    • y-field 控制y轴字段,可以是多个值

    • order 控制默认排序

  • model_icon 控制菜单的图标

    1. class BookInfoAdmin(object):
    2. model_icon = 'fa fa-gift'
    3.  
    4. xadmin.site.register(models.BookInfo, BookInfodmin)

drf项目案例及原理详解下载

三 drf 认证,权限,限流,过滤,排序,分页,异常处理,接口文档,集xadmin的使用的更多相关文章

  1. day74:drf:drf其他功能:认证/权限/限流/过滤/排序/分页/异常处理&自动生成接口文档

    目录 1.django-admin 2.认证:Authentication 3.权限:Permissions 4.限流:Throttling 5.过滤:Filtering 6.排序:OrderingF ...

  2. DRF 过滤排序分页异常处理

    DRF 中如何使用过滤,排序,分页,以及报错了如何处理?10分钟get了~

  3. SpringSecurity权限管理系统实战—二、日志、接口文档等实现

    系列目录 SpringSecurity权限管理系统实战-一.项目简介和开发环境准备 SpringSecurity权限管理系统实战-二.日志.接口文档等实现 SpringSecurity权限管理系统实战 ...

  4. drf07 过滤 排序 分页 异常处理 自动生成接口文档

    4. 过滤Filtering 对于列表数据可能需要根据字段进行过滤,我们可以通过添加django-fitlter扩展来增强支持. pip install django-filter 在配置文件sett ...

  5. DRF之接口文档以及Xadmin

    1. 自动生成接口文档 REST framework可以自动帮助我们生成接口文档. 接口文档以网页的方式呈现. 自动接口文档能生成的是继承自APIView及其子类的视图. 1.1. 安装依赖 REST ...

  6. django-rest-framework-源码解析004-三大验证(认证/权限/限流)

    三大验证模块概述 在DRF的APIView重写的dispatch方法中,  self.initial(request, *args, **kwargs) 这句话就是执行三大验证的逻辑, 点进去可以看到 ...

  7. DRF之过滤排序分页异常处理

    一.过滤 对于列表数据要通过字段来进行过滤,就需要添加 django-filter 模块 使用方法: # 1.注册,在app中注册 settings.py INSTALLED_APPS = [ 'dj ...

  8. rbac介绍、自动生成接口文档、jwt介绍与快速签发认证、jwt定制返回格式

    今日内容概要 RBAC 自动生成接口文档 jwt介绍与快速使用 jwt定制返回格式 jwt源码分析 内容详细 1.RBAC(重要) # RBAC 是基于角色的访问控制(Role-Based Acces ...

  9. drf频率源码、自动生成接口文档、JWT

    目录 一.drf频率源码分析 二.自动生成接口文档 1 安装依赖 2 设置接口文档访问路径 3 文档描述说明的定义位置 4 访问接口文档网页 三.JWT 1 JWT基本原理 1.1 header 1. ...

随机推荐

  1. 实际体验Span<T> 的惊人表现

    前言 最近做了一个过滤代码块功能的接口.就是获取一些博客文章做文本处理,然后这些博客文章的代码块太多了,很多重复的代码关键词如果被拿过来处理,那么会对文本的特征表示已经特征选择会有很大的影响.所以需要 ...

  2. vim快捷键与vi

    vim与程序员 所有的 Unix Like 系统都会内建 vi 文书编辑器,其他的文书编辑器则不一定会存在. 但是目前我们使用比较多的是 vim 编辑器. vim 具有程序编辑的能力,可以主动的以字体 ...

  3. 实现Linux下的ls和ls-l

    ls的C语言代码实现 #include <stdio.h> #include <sys/types.h> #include <sys/stat.h> #includ ...

  4. SQL[Err] ORA-00933: SQL command not properly ended

    原文链接:https://www.cnblogs.com/godtrue/p/3784526.html 1:可能SQL语句中关键字前后缺少空格 2:Oracle 给表起别名时,直接在表名的后面空格别名 ...

  5. PHP调用接口用post方法传送json数据

    1.核心代码: <?php require("helper.php"); header('content-type:text/html;charset=utf-8'); $k ...

  6. Cartographer源码阅读(7):轨迹推算和位姿推算的原理

    其实也就是包括两个方面的内容:类似于运动模型的位姿估计和扫描匹配,因为需要计算速度,所以时间就有必要了! 1. PoseExtrapolator解决了IMU数据.里程计和位姿信息进行融合的问题. 该类 ...

  7. 2019.04.12 Head First

    第一节 认识python python.exe -V python 会进入解释器 quit()命令会退出解释器 IDEL,一个python的集成开发环境,能够利用颜色突出语法的编辑器,一个调试工具,P ...

  8. python操作excel的读、计算、写----xlrd、copy

    import xlrd from xlutils.copy import copy class ExcelUtil: def __init__(self,excel_path=None,index=N ...

  9. NOIP2012借教室

    题目描述 Description 在大学期间,经常需要租借教室.大到院系举办活动,小到学习小组自习讨论,都需要 向学校申请借教室.教室的大小功能不同,借教室人的身份不同,借教室的手续也不一样. 面对海 ...

  10. Java IO--NIO(二)

    在我的上一篇文章JavaNIO详解(一)中介绍了关于标准输入输出NIO相关知识, 本篇将重点介绍基于网络编程NIO(异步IO). 异步IO 异步 I/O 是一种没有阻塞地读写数据的方法.通常,在代码进 ...