drf 配置文件 过滤类 全局异常 接口文档

drf 配置文件 过滤类 全局异常 接口文档

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

1.1、内置认证类：

BasicAuthentication

RemoteUserAuthentication

SessionAuthentication session认证，建议自己写
如果前端带着cookie过来，经过session的中间件，如果登录了，在request，user中就有当前登录用户
drf没有限制是登录
加入这个认证，如果没有登录，就不允许往后访问了

TokenAuthentication ：jswt认证，建议自己写

1.2、内置权限类

BasPermission：所有基类

AllowAny：允许所有

IsAuthenticated ：是否登录，登录了才有权限
认证类，如果登录了，返回（当前登录用户，None），如果没有登录返回 None

IsAdminUserauth的user表中is_staff字段是否为True，对后台管理有没有权限

1.3、内置频率类

BaseThrottle：所有基类

SimpleRateThrottle：咱们写频率类都继承它，少写代码

AnonRateThrottle：如果你想按ip地址限制，只需要在配置文件中配置

'DEFAULT_THROTTLE_RATES': {
        'anon': '3/m',
    	}

UserRateThrottle如果你想按用户id限制，只需要配置文件中配置

'DEFAULT_THROTTLE_RATES': {
        'user': '3/m',
    	}

2、django的配置文件，每个配置项的作用

必须大写才是配置项

django 项目要启动，要先加载配置文件，如果配置文件报错，项目运行不起来

from pathlib impor 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'

3、过滤类的其它使用

内置过滤类，只能通过?search=搜索条件 这种搜索，不能指定，name=三国&publish=出版社

3.1、第三方过滤类 django-filter

第三方：django-filter

1. pip3 install django-filter
2. 配置在视图类中配置：filter_backends = [DjangoFilterBackend,]
3. 配置搜索字段：filterset_fields = ['name', 'publish']
4. 支持搜方式：http://127.0.0.1:8000/books/?name=三国志&publish=南京出版社
   精准搜索，条件并且的关系

3.2、自定义 过滤类

自己写-自定义过滤类

1. 写一个类，继承BaseFilterBackend

2. 重写某个方法：filter_queryset，在该方法中实现过滤，返回qs对象

   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, ]
   

过滤类 模糊查询

app01/filter.py

from rest_framework.filters import BaseFilterBackend,SearchFilter

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 is None:
            f_queryset = queryset.filter(publish__name__icontains=publish)
        elif publish is None:
            f_queryset = queryset.filter(name__icontains=name)
        else:f_queryset=queryset.filter(name__icontains=name,publish__name__icontains=publish)
        # queryset = Book.objects.all().filter(name__icontains=name,publish__name__icontains=publish)
        return f_queryset

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

4、全局异常处理

drf 中无论在三大认证还是视图类的方法中执行，只要报错（主动异常），都能执行一个函数（异常处理的函数)
只要出了 异常在APIView的dispath中捕获了，执行了配置文件中配置的：'EXCEPTION_HANDLER':'rest_framework.views.exception_handler'

自己写一个函数：配置在配置文件中，以后出了异常，它就走咱们写的函数了

1. 统一返回格式{’code‘:101,'msg':错误信息}
2. 记录日志

写一个函数

def common_exception_handler(exc,context):
    #记录日志：只要要进入到这里面，一定是出了异常，只要出了异常就要记录日志
    request = context.get('request')  # 当此请求的request
    try:
        username = request.user.username
    except:
        username = '没有的登录'
    ctime = titme.time()
    path = request.path
    method_type = request.method
    print('%s用户，在%时间，在访问%s接口，通过%s请求访问，出了错误：%s'%(username,str(ctime),path.method_type,str(exc)))
    # 后期以上的代码要写到日志中
    
    response = exception_handler(exc,context)  # 内置的这个异常处理函数，只处理了drf自己的异常(继承了 APIException的异常)
    if response:  # 如果response 有值，说明错误被处理了
        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'
    }

5、接口文档

接口编写已经写完了，需要编写，接口文档，给前端的人使用

• 请求地址
• 请求方式
• 支持的编码格式
• 请求参数(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/

   输入邮箱：306334678@qq.com

   输入密码：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

6、扩展

1. 自定义一个过滤类，实现可以通过图书名或作者模糊匹配

3. 编写一个全局异常处理，让它生效

   

4. 使用django-filter实现模糊匹配