在应用的admin.py文件中
from app01 import modelsclass StudentAdmin(admin.ModelAdmin):list_display &＃61; [&＃39;id&＃39;,&＃39;name&＃39;,&＃39;age&＃39;,&＃39;class_null&＃39;]list_editable &＃61; [&＃39;name&＃39;,&＃39;age&＃39;] # 可直接在当前页面编辑# admin.site.register(models.Student)
admin.site.register(models.Student,StudentAdmin)
创建超级管理员用户
python manage.py createsuperuser
输入用户名和密码,邮箱可以不输入
在models.py中添加&＃xff1a;
...def __str__(self):return self.name
在总url.py中
path(&＃39;admin/&＃39;, admin.site.urls),
from rest_framework import settings源代码中可以看到它的默认使用在settings配置文件中&＃xff0c;我们可以进行下面的配置来覆盖默认配置
REST_FRAMEWORK &＃61; {&＃39;DEFAULT_AUTHENTICATION_CLASSES&＃39;: [#哪个写在前面&＃xff0c;优先使用哪个认证&＃39;rest_framework.authentication.SessionAuthentication&＃39;, # session认证&＃xff0c;admin后台其实就使用的session认证&＃xff0c;其实接口开发很少用到session认证&＃xff0c;所以我们通过配置可以改为其他认证&＃xff0c;比如后面项目里面我们用到jwt&＃xff0c;JSON WEB TOKEN认证&＃xff0c;或者一些配合redis的认证&＃39;rest_framework.authentication.BasicAuthentication&＃39;, # 基本认证&＃xff0c;工作当中可能一些测试人员会参与的话&＃xff0c;他们会将一些认证数据保存在内存当中&＃xff0c;然后验证的&＃xff0c;我们基本上用不上]
}
也可以在每个视图中通过设置authentication_classess属性来局部使用
from rest_framework.authentication import SessionAuthentication, BasicAuthentication
from rest_framework.views import APIViewclass ExampleView(APIView):# 类属性authentication_classes &＃61; [SessionAuthentication, BasicAuthentication] #也可以写成元祖形式的,到时候我们使用我们自己开发的认证组件的时候&＃xff0c;就需要自己写一个认证组件类&＃xff0c;然后写在列表中来使用...
写一个认证类 auth.py from rest_framework.authentication import BaseAuthentication
from rest_framework.exceptions import AuthenticationFailedclass Auth(BaseAuthentication):def authenticate(self, request):# request.POST.get(&＃39;username&＃39;)username &＃61; &＃39;root&＃39;if username &＃61;&＃61; &＃39;root&＃39;:return &＃39;root&＃39;,&＃39;oo&＃39; # request.user &＃61; root, request.auth &＃61; &＃39;oo&＃39;else:raise AuthenticationFailed(&＃39;登录认证失败&＃39;)
settings配置文件中使用
REST_FRAMEWORK &＃61; {&＃39;DEFAULT_AUTHENTICATION_CLASSES&＃39;: [...&＃39;app01.utils.auth.Auth&＃39;, #全局配置&＃xff0c;所有的接口请求过来&＃xff0c;都会执行这个类],}
from app01.utils.auth import Authclass Students1View(APIView):authentication_classes &＃61; [Auth,] #局部配置&＃xff0c;使用自定义的登录认证类def get(self,request):print(&＃39;>>>>>>&＃39;,request.user)print(&＃39;>>>>>>&＃39;,request.auth)all_data &＃61; models.Student.objects.all()serializer &＃61; StudentSerializer(instance&＃61;all_data,many&＃61;True)return Response(serializer.data)
权限控制可以限制用户对于视图的访问和对于具体数据对象的访问。
&＃39;DEFAULT_PERMISSION_CLASSES&＃39;: [# &＃39;app01.utils.auth.MyPermisson&＃39;, # 全局配置&＃39;rest_framework.permissions.IsAuthenticated&＃39;, #登录成功之后才能访问的一个权限],
在具体的视图中通过permission_classes属性来设置
from rest_framework.permissions import IsAuthenticated
from rest_framework.views import APIViewclass ExampleView(APIView):permission_classes &＃61; (IsAuthenticated,)...
提供的权限
如需自定义权限&＃xff0c;需继承rest_framework.permissions.BasePermission父类&＃xff0c;并实现以下两个任何一个方法或全部
.has_permission(self, request, view)
是否可以访问视图&＃xff0c;view表示当前视图对象
.has_object_permission(self, request, view, obj)
是否可以访问数据对象&＃xff0c;view表示当前视图&＃xff0c;obj为数据对象
settings配置文件中使用
&＃39;DEFAULT_PERMISSION_CLASSES&＃39;: [&＃39;app01.utils.auth.MyPermisson&＃39;, # 全局配置# &＃39;rest_framework.permissions.IsAuthenticated&＃39;, #登录成功之后才能访问的一个权限],
from app01.utils.auth import Auth,MyPermisson
class Students1View(APIView):# authentication_classes &＃61; [Auth,] #局部配置&＃xff0c;使用自定义的登录认证类permission_classes &＃61; [MyPermisson,]# 获取所有数据接口def get(self,request):print(&＃39;>>>>>>&＃39;,request.user)print(&＃39;>>>>>>&＃39;,request.auth)all_data &＃61; models.Student.objects.all()serializer &＃61; StudentSerializer(instance&＃61;all_data,many&＃61;True)return Response(serializer.data)
可以对接口访问的频次进行限制&＃xff0c;以减轻服务器压力。
在配置文件中&＃xff0c;使用DEFAULT_THROTTLE_CLASSES 和 DEFAULT_THROTTLE_RATES进行全局配置
&＃39;DEFAULT_THROTTLE_CLASSES&＃39;: (&＃39;rest_framework.throttling.AnonRateThrottle&＃39;, # 匿名用户&＃xff0c;未登录的&＃39;rest_framework.throttling.UserRateThrottle&＃39; # 经过登录之后的用户),
from rest_framework.throttling import UserRateThrottlethrottle_classes &＃61; [UserRateThrottle,]...
settings配置文件中使用
# 频率访问限制类# &＃39;DEFAULT_THROTTLE_CLASSES&＃39;: (# &＃39;rest_framework.throttling.AnonRateThrottle&＃39;, # 匿名用户&＃xff0c;未登录的# &＃39;rest_framework.throttling.UserRateThrottle&＃39; # 经过登录之后的用户# ),&＃39;DEFAULT_THROTTLE_RATES&＃39;: {&＃39;anon&＃39;: &＃39;3/minute&＃39;,&＃39;user&＃39;: &＃39;5/minute&＃39;},
DEFAULT_THROTTLE_RATES 可以使用 second, minute, hour 或day来指明周期。
源码&＃xff1a;
{&＃39;s&＃39;: 1, &＃39;m&＃39;: 60, &＃39;h&＃39;: 3600, &＃39;d&＃39;: 86400} m表示分钟&＃xff0c;可以写m&＃xff0c;也可以写minute
可选限流类
1&＃xff09; AnonRateThrottle
限制所有匿名未认证用户&＃xff0c;使用IP区分用户。
使用DEFAULT_THROTTLE_RATES[&＃39;anon&＃39;] 来设置频次
2&＃xff09;UserRateThrottle
限制认证用户&＃xff0c;使用User id 来区分。
使用DEFAULT_THROTTLE_RATES[&＃39;user&＃39;] 来设置频次
3&＃xff09;ScopedRateThrottle (待定…)
限制用户对于每个视图的访问频次&＃xff0c;使用ip或user id,先找的用户id&＃xff0c;没有设置用户id的话就会使用ip地址。
在具体视图中通过throttle_classess属性来配置
ScopedRateThrottle局部使用示例
settings.py内容
&＃39;DEFAULT_THROTTLE_RATES&＃39;: {&＃39;xx&＃39;: &＃39;3/minute&＃39;,&＃39;oo&＃39;: &＃39;5/minute&＃39;,},views.py内容from rest_framework.throttling import ScopedRateThrottleclass StudentAPIView(ListAPIView):queryset &＃61; models.Student.objects.all()serializer_class &＃61; StudentModelSerializerthrottle_classes &＃61; [ScopedRateThrottle,]throttle_scope &＃61; &＃39;xx&＃39;class StudentAPI2View(ListAPIView):queryset &＃61; models.Student.objects.all()serializer_class &＃61; StudentModelSerializerthrottle_classes &＃61; [ScopedRateThrottle, ]throttle_scope &＃61; &＃39;oo&＃39;urls.py内容path(r&＃39;students/&＃39;,views.StudentAPIView.as_view()),path(r&＃39;students2/&＃39;,views.StudentAPI2View.as_view()),
对于列表数据可能需要根据字段进行过滤&＃xff0c;我们可以通过添加django-fitlter扩展来增强支持。
pip install django-filter
在配置文件中增加过滤后端的设置&＃xff1a;
INSTALLED_APPS &＃61; [...&＃39;django_filters&＃39;, # 需要注册应用&＃xff0c;
]REST_FRAMEWORK &＃61; {...&＃39;DEFAULT_FILTER_BACKENDS&＃39;: (&＃39;django_filters.rest_framework.DjangoFilterBackend&＃39;,)
}
在视图中添加filter_fields属性&＃xff0c;指定可以过滤的字段
class Students8View(ModelViewSet):queryset &＃61; models.Student.objects.all()serializer_class &＃61; StudentSerializerfilter_fields &＃61; (&＃39;name&＃39;, &＃39;age&＃39;)#http://127.0.0.1:8001/app01/students8/?name&＃61;xx
对于列表数据&＃xff0c;REST framework提供了OrderingFilter过滤器来帮助我们快速指明数据按照指定字段进行排序。
使用方法&＃xff1a;
在类视图中设置filter_backends&＃xff0c;使用rest_framework.filters.OrderingFilter过滤器&＃xff0c;REST framework会在请求的查询字符串参数中检查是否包含了ordering参数&＃xff0c;如果包含了ordering参数&＃xff0c;则按照ordering参数指明的排序字段对数据集进行排序。
前端可以传递的ordering参数的可选字段值需要在ordering_fields中指明。
class Students8View(ModelViewSet):queryset &＃61; models.Student.objects.all()serializer_class &＃61; StudentSerializerfilter_backends &＃61; [OrderingFilter]ordering_fields &＃61; (&＃39;id&＃39;,&＃39;age&＃39;)# http://127.0.0.1:8001/app01/students8/?ordering&＃61;-id# 必须是ordering&＃61;某个值# -id 表示针对id字段进行倒序排序# id 表示针对id字段进行升序排序
from rest_framework.generics import ListAPIView
from students.models import Student
from .serializers import StudentModelSerializer
from django_filters.rest_framework import DjangoFilterBackend #需要使用一下它才能结合使用class Students8View(ModelViewSet):queryset &＃61; models.Student.objects.all()serializer_class &＃61; StudentSerializer# 因为filter_backends是局部过滤配置&＃xff0c;局部配置会覆盖全局配置,所以需要重新把过滤组件核心类再次声明,# 否则过滤功能会失效filter_backends &＃61; [OrderingFilter,DjangoFilterBackend]filter_fields &＃61; (&＃39;name&＃39;, &＃39;age&＃39;)ordering_fields &＃61; (&＃39;id&＃39;,&＃39;age&＃39;)# 针对的是继承的类中的list方法# http://127.0.0.1:8001/app01/students8/?age&＃61;30&ordering&＃61;-id
在配置文件中设置全局的分页方式
# 全局分页&＃xff0c;一旦设置了全局分页&＃xff0c;那么我们drf中的视图扩展类里面的list方法提供的列表页都会产生分页的效果。所以一般不用全局分页&＃39;DEFAULT_PAGINATION_CLASS&＃39;: &＃39;rest_framework.pagination.PageNumberPagination&＃39;,&＃39;PAGE_SIZE&＃39;: 2 # 每页最大数据量
可通过自定义Pagination类&＃xff0c;来为视图添加不同分页行为。在视图中通过pagination_class属性来指明。
from rest_framework.pagination import PageNumberPagination,LimitOffsetPaginationclass LargeResultsSetPagination(PageNumberPagination):page_size &＃61; 2 # 127.0.0.1:8001/students/?page&＃61;5&size&＃61;10page_query_param &＃61; &＃39;pp&＃39; # # 自定义页码的参数名page_size_query_param &＃61; &＃39;size&＃39; max_page_size &＃61; 5class LargePagination(LimitOffsetPagination):default_limit &＃61; 3 #一页显示3条class Students8View(ModelViewSet):queryset &＃61; models.Student.objects.all()serializer_class &＃61; StudentSerializer# filter_backends &＃61; [OrderingFilter,DjangoFilterBackend]# filter_fields &＃61; (&＃39;name&＃39;, &＃39;age&＃39;)# ordering_fields &＃61; (&＃39;id&＃39;,&＃39;age&＃39;)pagination_class &＃61; LargePagination
注意&＃xff1a; 如果在视图内关闭分页功能&＃xff0c;只需在视图内设置
pagination_class &＃61; None
1&＃xff09; PageNumberPagination
前端访问网址形式&＃xff1a;
GET http://127.0.0.1:8001/students/?page&＃61;4
可以在子类中定义的属性&＃xff1a;
2&＃xff09;LimitOffsetPagination
前端访问网址形式&＃xff1a;其实就是通过偏移量来取数据
GET http://127.0.0.1/four/students/?limit&＃61;100&offset&＃61;400 #从下标为400的记录开始&＃xff0c;取100条记录
可以在子类中定义的属性&＃xff1a;
view.py
class APIError(Exception):passclass Test(APIView):def get(self,request):try:models.Student.objects.get(pk&＃61;100)except models.Student.DoesNotExist:raise APIError(&＃39;错啦错啦&＃64;!!&＃39;)return Response({&＃39;msg&＃39;:&＃39;查询出错啦&＃39;})return Response({&＃39;msg&＃39;:&＃39;xxxxx&＃39;})
urls.py
path(&＃39;test/&＃39;, views.Test.as_view()),
myexceptions.py
from rest_framework.views import exception_handler
from app01.views import APIError
from rest_framework.response import Responsedef myexception_handler(exc, context):ret &＃61; exception_handler(exc, context)# print(&＃39;xxxxxxxxxxxxxxxxxxx&＃39;)print(exc,type(exc)) #错啦错啦&＃64;!!
在配置文件中settings.py声明自定义的异常处理
&＃39;EXCEPTION_HANDLER&＃39;: &＃39;app01.myexceptions.myexception_handler&＃39;,
from rest_framework.views import exception_handler as drf_exception_handler
from rest_framework import status
from django.db import DatabaseErrordef exception_handler(exc, context):response &＃61; drf_exception_handler(exc, context)if response is None:view &＃61; context[&＃39;view&＃39;] #出错的方法或者函数名称if isinstance(exc, DatabaseError):print(&＃39;[%s]: %s&＃39; % (view, exc))response &＃61; Response({&＃39;detail&＃39;: &＃39;服务器内部错误&＃39;}, status&＃61;status.HTTP_507_INSUFFICIENT_STORAGE)return response
也就是说&＃xff0c;上面列出来的异常不需要我们自行处理了&＃xff0c;很多的没有在上面列出来的异常&＃xff0c;就需要在自定义异常中处理。
REST framework可以自动帮助我们生成接口文档。接口文档以网页的方式呈现。
自动接口文档能生成的是继承自APIView及其子类的视图。
REST framewrok生成接口文档需要coreapi库的支持。
pip install coreapi
在settings.py中&＃xff1a;
&＃39;DEFAULT_SCHEMA_CLASS&＃39;: "rest_framework.schemas.AutoSchema",
在总路由urls.py中添加接口文档路径。
文档路由对应的视图配置为rest_framework.documentation.include_docs_urls&＃xff0c;参数title为接口文档网站的标题。
from rest_framework.documentation import include_docs_urls...path(&＃39;docs/&＃39;, include_docs_urls(title&＃61;&＃39;站点页面标题&＃39;))
def post(self, request):"""这是添加一条记录的接口:param request: 请求对象:return: json类型"""...
浏览器访问 127.0.0.1:8001/docs/&＃xff0c;即可看到自动生成的接口文档。
两点说明&＃xff1a;
1&＃xff09;视图集ViewSet中的retrieve名称&＃xff0c;在接口文档网站中叫做read
2&＃xff09;参数的Description需要在模型类或序列化器类的字段中以help_text选项定义&＃xff0c;如&＃xff1a;
class Student(models.Model):...name &＃61; models.CharField(max_length&＃61;100,verbose_name&＃61;"姓名",help_text&＃61;&＃39;提示文本&＃xff1a;不能为空&＃39;)...
xadmin是Django的第三方扩展&＃xff0c;比使用Django的admin站点更强大也更方便。
文档&＃xff1a;https://xadmin.readthedocs.io/en/latest/index.html
GitHub地址&＃xff1a;https://github.com/sshwsfc/django-xadmin
通过如下命令安装xadmin的最新版
pip install https://codeload.github.com/sshwsfc/xadmin/zip/django2
在配置文件中注册如下应用
INSTALLED_APPS &＃61; [...&＃39;xadmin&＃39;,&＃39;crispy_forms&＃39;,&＃39;reversion&＃39;,...
]# 修改使用中文界面
LANGUAGE_CODE &＃61; &＃39;zh-Hans&＃39;# 修改时区
TIME_ZONE &＃61; &＃39;Asia/Shanghai&＃39;
xadmin有建立自己的数据库模型类&＃xff0c;需要进行数据库迁移
python manage.py makemigrations
python manage.py migrate
在总路由中添加xadmin的路由信息
import xadmin
xadmin.autodiscover()# version模块自动注册需要版本控制的 Model
from xadmin.plugins import xversion
xversion.register_models()urlpatterns &＃61; [path(r&＃39;xadmin/&＃39;, xadmin.site.urls),
]
如果之前没有创建超级用户&＃xff0c;需要创建&＃xff0c;如果有了&＃xff0c;则可以直接使用之前的。
python manage.py createsuperuser
admin.ModelAdmin&＃xff0c;而是直接继承object即可。在子应用中创建adminx.py文件。
站点的全局配置
import xadmin
from xadmin import viewsclass BaseSetting(object):"""xadmin的基本配置"""enable_themes &＃61; True # 开启主题切换功能use_bootswatch &＃61; True # 引导控制盘(其实就是我们的左侧菜单栏)xadmin.site.register(views.BaseAdminView, BaseSetting)class GlobalSettings(object):"""xadmin的全局配置"""site_title &＃61; "皇家赌场" # 设置站点标题site_footer &＃61; "皇家有限公司" # 设置站点的页脚menu_style &＃61; "accordion" # 设置菜单折叠xadmin.site.register(views.CommAdminView, GlobalSettings)
站点Model管理
xadmin可以使用的页面样式控制基本与Django原生的admin一直。
可以在models类中定义个__str__方法来定义对象显示成什么内容
list_display控制列表展示的字段
list_display &＃61; [&＃39;id&＃39;, &＃39;btitle&＃39;, &＃39;bread&＃39;, &＃39;bcomment&＃39;]
search_fields控制可以通过搜索框搜索的字段名称&＃xff0c;xadmin使用的是模糊查询
search_fields &＃61; [&＃39;id&＃39;,&＃39;btitle&＃39;]
*ist_filter可以进行过滤操作的列&＃xff0c;对于分类、性别、状态
list_filter &＃61; [&＃39;is_delete&＃39;]
ordering默认排序的字段
ordering &＃61; [&＃39;-age&＃39;,] #-倒序
show_detail_fields在列表页提供快速显示详情信息
show_detail_fields &＃61; [&＃39;id&＃39;,]
list_editable在列表页可以快速直接编辑的字段
list_editable &＃61; [&＃39;name&＃39;,&＃39;age&＃39;,]
refresh_times指定列表页的定时刷新
refresh_times &＃61; [5, 10,30,60] # 设置允许后端管理人员按多长时间(秒)刷新页面,选好之后就能自动刷新了
list_export控制列表页导出数据的可选格式
list_export &＃61; (&＃39;xls&＃39;, &＃39;json&＃39;,&＃39;csv&＃39;)#写元祖或者列表都行 list_export设置为None来禁用数据导出功能
list_export_fields &＃61; (&＃39;id&＃39;, &＃39;btitle&＃39;, &＃39;bpub_date&＃39;) #设置允许导出的字段
show_bookmarks控制是否显示书签功能
show_bookmarks &＃61; True #False就隐藏了这个功能
data_charts控制显示图表的样式
data_charts &＃61; {"order_amount": { #随便写的名称order_amount&＃39;title&＃39;: &＃39;图书发布日期表&＃39;, "x-field": "bpub_date", "y-field": (&＃39;btitle&＃39;,),"order": (&＃39;id&＃39;,),},# 支持生成多个不同的图表# "order_amount2": {# &＃39;title&＃39;: &＃39;图书发布日期表&＃39;, # "x-field": "bpub_date", # "y-field": (&＃39;btitle&＃39;,),# "order": (&＃39;id&＃39;,)# },}
model_icon控制菜单的图标【图标的设置可以参考font-awesome的图标css名称】
model_icon &＃61; &＃39;fa fa-gift&＃39;
readonly_fields在编辑页面的只读字段
readonly_fields &＃61; [&＃39;name&＃39;,]
exclude在编辑页面隐藏的字段,比如判断这个数据是否删除的delete_status字段&＃xff0c;一般就是用来标识一下字段是不是被删除了&＃xff0c;但是数据库中不删除
exclude &＃61; [&＃39;name&＃39;,]
这并不是所有功能&＃xff0c;可以参看它的文档&＃xff0c;它提供的一些功能可能还需要自定制&＃xff0c;调整或者添加一些它没有的功能
京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有 