drf之day09:内置的认证类，权限类，频率类，django配置文件解析，过滤类的其他作用，全局异常处理，接口文档

目录标题

一：内置的认证类，权限类，频率类
- 1.内置的认证类
- 2.内置的权限类
- 3.内置的频率类
二：django配置文件中每个配置的作用
三：过滤类的其他使用
- 1第三方：django-filter模块的使用
- 2.自己写一个自定义类
- 3.多个过滤类和排序类共用
四：全局异常处理
- 1.drf内置的全局异常处理
- 2.自定义全局异常处理函数
五：接口文档
- 1.接口文档的作用及其内容格式
- 2.大部分公司的写法
练习：

一：内置的认证类，权限类，频率类

1.内置的认证类

种类

# 1.BasicAuthentication# 2.RemoteUserAuthentication# 3.SessionAuthentication：session认证：drf没有限制是否登录，加了这个认证，如果没有登录，就不允许往后访问了；如果前端带着cookie过来，经过session的中间件，如果登录了，在request.user中就有当前登录用户# 4.TokenAuthentication：jwt认证，建议自己写

2.内置的权限类

# 1.BasePermission：所有的基类# 2.AllowAny：允许所有# 3.IsAuthenticated：是否登录，登录了才有权限,认证类，如果登录了，返回(当前登录用户,None), 如果没有登录返回 None# 4.IsAdminUser：auth的user表中is_staff字段是否为True，对后台管理有没有权限

3.内置的频率类

# 1.BaseThrottle：所有的基类# 2.SimpleRateThrottle：咱们写频率类都继承它，少写代码# 3.AnonRateThrottle：如果你想按ip地址限制，只需要在配置文件中配置'DEFAULT_THROTTLE_RATES': {'anon': '3/m',}# 4.UserRateThrottle:如果你想按用户id限制，只需要在配置文件中配置'DEFAULT_THROTTLE_RATES': {'user': '3/m',}

二：django配置文件中每个配置的作用

# 必须大写才是配置项
# django项目要启动，要先加载配置文件，如果配置文件报错，项目运行不起来from pathlib import Path
# 项目根路径
BASE_DIR = Path(__file__).resolve().parent.parent# 密钥，自动生成的，很复杂，django中涉及到加密的都使用它，没有不行
SECRET_KEY = 'django-insecure-4i$6azd399fl$vh9%*7#oald(i&ik(5#i_-y)v&z3g+cxsd$@-'# 如果是True，项目是调试模式，好处是抛异常在浏览器直接能看到,如果路径不存在，也会提示有哪些路径
DEBUG = True
# 允许项目部署的地址（后期项目上线，这里写服务器的地址），debug是False，这个必须加，不加就报错
ALLOWED_HOSTS = ['*']# 所有的app，django大而全，就是因为它提供了很多内置的app
INSTALLED_APPS = ['django.contrib.admin', # 后台管理admin'django.contrib.auth', # 权限，6个表'django.contrib.contenttypes','django.contrib.sessions',# session认证相关 ---》django_session表'django.contrib.messages', # 消息框架（不了解）'django.contrib.staticfiles',# 静态文件'app01.apps.App01Config', # app01'rest_framework',
]
# 中间件
MIDDLEWARE = ['django.middleware.security.SecurityMiddleware',  #'django.contrib.sessions.middleware.SessionMiddleware', # session相关'django.middleware.common.CommonMiddleware',           #把路径跟路由匹配，如果匹配不成功把路径加/ 再匹配，如果匹配成功，让该请求重定向到带/的地址'django.middleware.csrf.CsrfViewMiddleware', # csrf相关'django.contrib.auth.middleware.AuthenticationMiddleware', # 认证相关'django.contrib.messages.middleware.MessageMiddleware',  # 消息框架，学到flask，闪现相同的功能'django.middleware.clickjacking.XFrameOptionsMiddleware',
]# 根路由，所有请求进来，先去根路由匹配---》内部可能有路由分发
ROOT_URLCONF = 'drf_day08.urls'# 模板相关
TEMPLATES = [
]# 后期项目项目上线，uwsgi运行这个application，测试阶段使用manage.py 运行项目
WSGI_APPLICATION = 'drf_day08.wsgi.application'# 数据库配置 【可以使用多数据库】
DATABASES = {'default': {'ENGINE': 'django.db.backends.sqlite3','NAME': BASE_DIR / 'db.sqlite3',}
}# auth的认证相关# 国际化
LANGUAGE_CODE = 'en-us'
TIME_ZONE = 'UTC'
USE_I18N = True
USE_L10N = True
USE_TZ = True# 静态文件相关
STATIC_URL = '/static/'
# 所有的自增主键都用BigAutoField
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

三：过滤类的其他使用

内置的过滤类只能通过：?search=条件，不能指定过滤字段：name=水&publish=上海

1第三方：django-filter模块的使用

1.先导入模块

 pip3 install django-filter

2.配置在视图类中

filter_backends = [DjangoFilterBackend, ]

3.在视图类中配置过滤字段

filterset_fields = ['name', 'publish']

4.支持的搜索方式

http://127.0.0.1:8008/books/?name=三国演义&publish=南京出版社

2.自己写一个自定义类

1.写一个类，继承：BaseFilterBackend
2.重写filter_queryset方法，在该方法中实现过滤功能，返回过滤之后的数据对象

def filter_queryset(self, request, queryset, view):# 在这里面实现过滤，一定要返回qs对象，过滤后的数据name = request.query_params.get('name', None)publish = request.query_params.get('publish', None)qs = queryset.filter(name__icontains=name, publish__icontains=publish)return qs

3.配置在视图类上

 filter_backends = [MyFilter, ]

3.多个过滤类和排序类共用

filter_backends=[],可以配置多个，执行顺序是从做往右，所以，放在最左侧的尽量先过滤掉大部分数据

四：全局异常处理

1.drf内置的全局异常处理

drf中无论在三大认证还是视图类的方法中执行，只要报错(主动抛异常)，都能执行一个函数（异常处理的函数）
只要除了异常在APIView的dispatch中捕获了，执行了配置文件中配置

的：‘EXCEPTION_HANDLER’: ‘rest_framework.views.exception_handler’

2.自定义全局异常处理函数

1.自己写一个函数，配置在配置文件中，以后出了异常，它就走咱们写的函数了
-1 统一返回格式 {‘code’:101,‘msg’:错误信息}
-2 记录日志

# 写一个函数
def common_exception_handler(exc, context):# 记录日志：只要进入到这里面，一定是出了异常，只要出异常就要记录日志request = context.get('request')  # 当此请求的requesttry:username = request.user.usernameexcept:username = '没有登录'ctime = time.time()path = request.pathmethod_type = request.methodprint('%s用户，在%s时间，访问%s接口,通过%s请求访问，出了错误：%s' % (username, str(ctime), path, method_type, str(exc)))# 后期以上的代码要写到日志中response = exception_handler(exc, context)  # 内置的这个异常处理函数，只处理了drf自己的异常(继承了了APIException的异常)if response:  # 如果response有值，说明错误被处理了(Http404,PermissionDenied,APIException)return Response({'code': 888, 'msg': 'drf错误,错误原因是:%s' % response.data.get('detail', '未知错误')})else:  # 如果是None，这个错误没有被处理，说明这个错误不是drf的错误，而是django的或代码的错误return Response({'code': 999, 'msg': '系统错误，错误原因是：%s' % str(exc)})# 配置在配置文件中REST_FRAMEWORK = {'EXCEPTION_HANDLER': 'app01.exctptions.common_exception_handler'}

五：接口文档

1.接口文档的作用及其内容格式

接口编写已经写完了,需要编写接口文档，给前端的人使用
-请求地址
-请求方式
-支持的编码格式
-请求参数(get,post参数)
-返回格式示例

2.大部分公司的写法

# 第一种写法：
-1 直接使用word或者md写# 第二种写法
-2 使用接口文档平台，在接口文档平台录入(Yapi（百度开源的自己搭建）,第三方平台(收费)，自己开发接口文档平台)-https://www.showdoc.com.cn/item/index- 不想花钱，没有能力开发，就使用开源的YAPI，https://zhuanlan.zhihu.com/p/366025001- https://www.liuqingzheng.top:3000/输入邮箱：306334678@qq.com输入密码：admin# 第三种写法
-3 项目自动生成：swagger，coreapi-1 下载：pip3 install coreapi-2 路由中配置：from rest_framework.documentation import include_docs_urlsurlpatterns = [path('docs/', include_docs_urls(title='站点页面标题'))]-3 在视图类中加注释-4 在配置文件中配置REST_FRAMEWORK = {'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',}# 注意：-直接在视图类中写注释-在序列化类上写help_text
class BookSerializer(serializers.ModelSerializer):class Meta:model = Bookfields = '__all__'extra_kwargs = {"name": {"help_text": "图书名字"}}

练习：

class NewFilter(BaseFilterBackend):def filter_queryset(self, request, queryset, view):name = request.query_params.get('name', None)publish = request.query_params.get('publish', None)if name and publish:qs = queryset.filter(Q(name__icontains=name) | Q(publish__icontains=publish))return qselif name:qs = queryset.filter(name__icontains=name)return qselse:qs = queryset.filter(publish__icontains=publish)return qs

# 使用django-filter实现模糊匹配
# 方式一：
class BookFilter(django_filters.rest_framework.FilterSet):name = django_filters.CharFilter(field_name='name', lookup_expr='icontains')class Meta:model = Bookfields = ['name']# 方式二：
class BookFilter(django_filters.rest_framework.FilterSet):class Meta:model = Bookfields = {"name": "icontains"}

drf之day09:内置的认证类，权限类，频率类，django配置文件解析，过滤类的其他作用，全局异常处理，接口文档相关推荐

华为无线AC 配置内置Portal认证和Radius服务器示例
配置内置Portal认证示例组网图形图1 配置内置Portal认证组网图 · 组网需求 · 配置思路 · 数据规划 · 操作步骤 · 配置文件组网需求如图1所示,某企业AC直连AP.通过WLA ...
php radius web认证,内置WEB认证配置（radius认证）
本帖 * 后由浪天涯星仔于 2016-1-9 20:14 编辑功能介绍: Web认证是一种对用户访问网络的权限进行控制的身份认证方法,这种认证方法不需要用户安装专用的客户端认证软件,使用普通的浏 ...
6.DRF IP限次访问JWT认证RBAC权限缓存
文章目录 0. 准备环境 1. 自定义频率限制 1.1 SimpleRateThrottle源码 1.2 SimpleRateThrottle使用 1.3 自定义模块 2. API接口文档 3. JW ...
DRF 自动生成接口文档
Python微信订餐小程序课程视频 https://edu.csdn.net/course/detail/36074 Python实战量化交易理财系统 https://edu.csdn.net/cou ...
drf 安装_drf 生成接口文档
REST framework可以自动帮助我们生成接口文档.接口文档以网页的方式呈现. 自动接口文档能生成的是继承自APIView及其子类的视图. 一.安装依赖 REST framewrok生成接口文档 ...
SpringBoot 配置 generator代码生成+knife4j接口文档（2种模板设置、逻辑删除、字段填充含代码粘贴可用）保姆级教程（注意事项+建表SQL+代码生成类封装+测试类）
保姆级教程,逻辑删除及字段自动填充设置,特别要说明的是本次用的是MySQL数据库,如果使用Oracle数据库是,数据库配置需要改变,数据库表一定要大写,否则无法生成代码. 数据库表 CREATE TA ...
实体类接口_spring-boot-route（五）整合Swagger生成接口文档
目前,大多数公司都采用了前后端分离的开发模式,为了解决前后端人员的沟通问题,后端人员在开发接口的时候会选择使用swagger2来生成对应的接口文档,swagger2提供了强大的页面调试功能,这样可以有 ...
Ajax→异步的JavaScript和XML、HTTP请求响应、Ajax简介同步异步、XMLHttpRequest类的方法及属性、原生Ajax、Koa实现Ajax、接口文档、浏览器同源策略、反向代理
浏览器服务器 HTTP请求响应数据库后端语言 Ajax简介同步异步 Koa前端框架 XMLHttpRequest类的方法及属性原生Ajax Koa实现Ajax JSON DOM 接口文档浏览器同 ...
Django DRF 自动生成接口文档
文章目录 1. 引子 2. 自动生成接口文档 3. 文档描述说明的定义位置 1. 引子前端请求的url由谁来写 url 主要有后台来写,写完给前端: 如果后台查询数据,需要借助查询条件才能查询前端需 ...
快递鸟顺丰、申通物流查询类通用接口文档
顺丰.申通.圆通.韵达.京东物流轨迹查询类接口文档, 1.在途监控快递鸟汇集国内外1600多家快递公司的物流轨迹数据,以接口形式开放给用户使用,支持即时查询+订阅两种调用方式,为用户提供全流程的物流 ...

drf之day09:内置的认证类，权限类，频率类，django配置文件解析，过滤类的其他作用，全局异常处理，接口文档

目录标题

一：内置的认证类，权限类，频率类

1.内置的认证类

2.内置的权限类

3.内置的频率类

二：django配置文件中每个配置的作用

三：过滤类的其他使用

1第三方：django-filter模块的使用

2.自己写一个自定义类

3.多个过滤类和排序类共用

四：全局异常处理

1.drf内置的全局异常处理

2.自定义全局异常处理函数

五：接口文档

1.接口文档的作用及其内容格式

2.大部分公司的写法

练习：

drf之day09:内置的认证类，权限类，频率类，django配置文件解析，过滤类的其他作用，全局异常处理，接口文档相关推荐

最新文章

热门文章