• 内置认证类、权限类、频率类

• django配置文件介绍

• 过滤类的其他使用

• 全局异常处理

• 接口文档

内置认证类、权限类、频率类

# 内置的认证类
	BasicAuthentication	： 基类
	RemoteUserAuthentication
	SessionAuthentication: session认证，建议自己写
		作用：前端带着cookie进来，经过session中间件。如果登录了，request.user中就有当前登录的用户。drf本身没有限制必须登录，加了这个认证之后，如果么有登录就不能继续访问了。
	TokenAuthentication： jwt认证

# 内置权限类
	BasePermission： 基类
	AllowAny： 不加权限，允许所有人访问
	IsAuthenticated： 是否登录，登录了才有权限
		认证类：如果登录了，返回当前登录用户，反之返回None
	IsAdminUser： auth的user表中is_staff字段是否为True。决定有没有后台管理的权限

# 内置频率类
	BaseThrottle： 基类
	SimpleRateThrottle： 咱们写频率类都继承它，少写代码
	AnonRateThrottle：如果你想按ip地址限制，只需要在配置文件中配置
    'DEFAULT_THROTTLE_RATES': {
        'anon': '3/m',
    }
    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-_!cy9-tflex#m#2!6krc3@ythidtf-lkqho&r+0j&j(l++$h&u'
# 是否调试模式  该模式下，抛异常能在浏览器直接看到，如果路径不存在会提示有哪些可用路径
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
    'django_filters'
]
# 中间件
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', # 消息框架
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
# 跟路由 所有请求进来 先去跟路由匹配 -->内部可能有路由分发
ROOT_URLCONF = 'drf09.urls'
# 模板相关
TEMPLATES = [
]
# 后期项目项目上线，uwsgi运行这个application，测试阶段使用manage.py 运行项目
WSGI_APPLICATION = 'drf09.wsgi.application'
# 数据库配置 【可以使用多数据库】
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}
# auth认证相关
AUTH_PASSWORD_VALIDATORS = [
]
# 国际化
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'
# drf配置
REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'app01.exception.common_exception_handler',
    'DEFAULT_FILTER_BACKENDS': (
        'django_filters.rest_framework.DjangoFilterBackend',),
}

过滤类的其他使用

# 内置的过滤类 ：只能指定?search=xxx  这种搜索不能指定name=xx&publish=xx 不是很方便
# 第三方过滤类 ： 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=南京出版社
		默认是精准搜索(非模糊匹配)，条件是 和 的关系    
# 自己写的过滤类
	1.写一个类，继承BaseFilterBackend
	2.重写filter_queryset方法，在该方法中实现复杂过滤逻辑，结果返回queryset对象
		class Myfilter(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(name__icontains=name, publish__icontains=publish)
                    return qs
                else:
                    return queryset
	3.配置在视图类上
    	filter_backends = [MyFilter, ]
# 视图类的配置是一个列表，多个过滤类可以提升使用，执行顺序从左到右，因此尽量左侧的先过滤掉大量的数据

全局异常处理

# drf中无论三大认证还是视图类中方法的执行中报错(或者主动抛出异常)，都能自动执行一个异常处理的函数
# 只要出了异常就能在APIView的dispatch中捕获到，并且执行配置文件中的配置：
	'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler' # 自带的
我们可以自己写异常处理的函数来额外捕获其他类型的错误(drf中未定义)的并处理
	要求：
		1.统一错误返回格式，如：{'code':101,'msg':错误信息}
		2.记录日志

自己写异常处理函数

def common_exception_handler(exc, context):
	# 这里可以记录日志：只要进了这个函数 一定是程序出来异常，只要出异常就要记录日志
    request = context.get('request')  # 当前请求的request对象(放在了context参数里)
    try:
        username = request.user.get('username')
    except:
        username = '没有登录'
    ctime = time.time()
    method = request.method
    path = request.path
    print(f'用户{username}在{ctime}时发送{method}请求访问了{path}出错，报错信息为{str(exc)}')  # 返回错误信息的代码可以写到日志中
    
    response = exception_handler(exc, context) # exception_handler内置的异常处理函数，只处理了drf自己的异常(继承了了APIException)
    if response:  # 如果response有值，说明错误为以下几种类型，已经被drf被处理了(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)})


settings.py: # 全局配置异常处理
REST_FRAMEWORK = {
	# 我们自己基于drf的异常处理，扩充写的异常处理函数
	'EXCEPTION_HANDLER': 'app01.exctptions.common_exception_handler'
}

接口文档

# 接口写完之后，还要编写接口文档，用于给前端人员看，接口文档一般包含：
	请求地址
	请求方式
	支持的编码格式
	氢气参数(get，post参数)
	返回格式实例
# 接口文档写法
	-1 直接使用word或者md写
	-2 使用接口文档平台，在接口文档平台录入(Yapi（百度开源的自己搭建）,第三方平台(收费)，自己开发接口文档平台)
    	-https://www.showdoc.com.cn/item/index
        - 不想花钱，没有能力开发，就使用开源的YAPI，https://zhuanlan.zhihu.com/p/366025001
        - https://www.liuqingzheng.top:3000/
        	 输入邮箱：[email protected]
			输入密码：admin
    -3 项目自动生成：swagger，coreapi
		-1 下载：pip3 install coreapi
		-2 路由中配置：
        from rest_framework.documentation import include_docs_urls
        urlpatterns = [
            path('docs/', include_docs_urls(title='站点页面标题'))
        ]
        -3 在视图类中加注释
        -4 在配置文件中配置
        REST_FRAMEWORK = {
         'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
        }
        
        # 注意：
        	-直接在视图类中写注释
            -在序列化类上写help_text