内置认证类，权限类，频率类
内置的认证类：
- BasicAuthentication
- RemoteUserAuthentication
- SessionAuthentication(session认证，建议自己写)
- 如果前端带着cookie过来，经过session的中间件，如果登录了，在request.user中就有当前登录用户
- drf没有限制是否登录
- 加了这个认证，如果没有登录，就不允许往后访问了
- TokenAuthentication：jwt认证，建议自己写
内置权限类
- BasePermission：所有的基类
- AllowAny：允许所有
- IsAuthenticated：是否登录，登录了才有权限
- 认证类，如果登录了，返回(当前登录用户,None), 如果没有登录返回 None
- IsAdminUser：auth的user表中is_staff字段是否为True，对后台管理有没有权限
内置的频率类：
-
BaseThrottle：所有的基类
- SimpleRateThrottle：咱们写频率类都继承它，少写代码
-
AnonRateThrottle：如果你想按ip地址限制，只需要在配置文件中配置
REST_FRAMEWORK = {
'DEFAULT_THROTTLE_CLASSES': (
'rest_framework.throttling.AnonRateThrottle',
),
'DEFAULT_THROTTLE_RATES': {
'anon': '3/m',
}
}
# 使用 `second`, `minute`, `hour` 或`day`来指明周期。
# 可以全局使用，局部使用
- UserRateThrottle:如果你想按用户id限制，只需要在配置文件中配置
REST_FRAMEWORK = {
'DEFAULT_THROTTLE_CLASSES': (
'rest_framework.throttling.UserRateThrottle'
),
'DEFAULT_THROTTLE_RATES': {
'user': '10/m'
}
}
# 可以全局使用，局部使用
总结
AnonRateThrottle：限制所有匿名未认证用户，使用IP区分用户
UserRateThrottle：限制认证用户，使用user id来区分
ScopedRateThrottle：限制用户对于每个视图的访问频次，使用ip或者user id
补充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 = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [BASE_DIR / 'templates']
,
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
],
},
},
]
# 后期项目项目上线，uwsgi运行这个application，测试阶段使用manage.py 运行项目
WSGI_APPLICATION = 'drf_day08.wsgi.application'
# 数据库配置 【可以使用多数据库】
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': BASE_DIR / 'db.sqlite3',
}
}
# auth的认证相关
AUTH_PASSWORD_VALIDATORS = [
{
'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
},
]
# 国际化
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中无论在三大认证还是视图类的方法中执行，只要报错(主动抛异常)，都能执行一个函数（异常处理的函数）
只要除了异常在APIView的dispatch中捕获了，执行了配置文件中配置的:'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler'
我们自己写一个函数，配置在配置文件中，以后出了异常，它就走咱们写的函数了
- 1.统一返回格式
{'code':101,'msg':错误信息} - 2.记录日志等
代码演示
from rest_framework.response import Response
from rest_framework.views import exception_handler
from datetime import datetime
from django.utils.translation import gettext_lazy as _
def new_exception_handler(exc, context):
response=exception_handler(exc,context)
request = context.get('request')
try:
username=request.user.username
except:
username='AnonymousUser'
if response:
return Response(
{
'code':-1,
'msg':f'drf的异常，异常错误为:{_(response.data.get("detail"))}',
'请求路径为':request.path_info,
'用户':username,
'访问时间':datetime.now().strftime('%Y-%m-%d %X')
}
)
else:
return Response(
{
'code':999,
'msg':f'django的异常，异常错误为:{_(str(exc))}',
'请求路径为':request.path_info,
'用户': username,
'访问时间': datetime.now().strftime('%Y-%m-%d %X')
}
)
# 配置在配置文件中
REST_FRAMEWORK = {
'EXCEPTION_HANDLER': 'app01.exctptions.common_exception_handler'
}
接口文档
接口编写已经写完了 需要编写接口文档，给前端的人使用
- 请求地址
- 请求方式
- 支持的编码格式
- 请求参数(get,post参数)
- 返回的格式示例
在公司里的写法
- 1.直接使用word或者md写
- 2.使用接口文档平台，在接口文档平台录入(Yapi(百度开源的自己搭建),第三方平台(收费)，或自己开发的接口文档平台)
- 3.不想花钱，没有能力开发，就使用开源的YAPI
https://www.liuqingzheng.top:3000/
输入邮箱：306334678@qq.com
输入密码：admin
项目自动生成(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',
}
5.在序列化类上写help_text
eg:
class BookListView(generics.ListAPIView):
"""
返回所有图书信息.
"""
文档描述说明的定义位置
- 单一方法的视图，可直接使用类视图的文档字符串
class BookListView(generics.ListAPIView):
"""
返回所有图书信息.
"""
- 包含多个方法的视图，在类视图的文档字符串中，分开方法定义
class BookListCreateView(generics.ListCreateAPIView):
"""
get:
返回所有图书信息.
post:
新建图书.
"""
- 对于视图集ViewSet,仍在类视图的文档字符串中分开定义，但是应使用action名称区分
class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
"""
list:
返回图书列表数据
retrieve:
返回图书详情数据
latest:
返回最新的图书数据
read:
修改图书的阅读量
"""
注意：
restframework版本在3.10以上的需要指定默认schema
REST_FRAMEWORK = {
'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema'
}
posted on
浙公网安备 33010602011771号