【愚公系列】2022年04月 Python教学课程 71-DRF框架之内置路由

简介: 【愚公系列】2022年04月 Python教学课程 71-DRF框架之内置路由

一、路由

对于视图集ViewSet,我们除了可以自己手动指明请求方式与视图方法[官方文档中也叫action,动作]之间的对应关系外,还可以使用Routers来帮助我们自动生成路由信息。


REST framework提供了两个router


SimpleRouter

DefaultRouter

1.SimpleRouter

1.1 基本使用

from rest_framework import routers
router = routers.SimpleRouter()
router.register(r'users', UserViewSet)
router.register(r'accounts', AccountViewSet)
urlpatterns = router.urls

该方法有两个必需的参数:register()


prefix- 用于这组路由的 URL 前缀。

viewset- 视图集类。

(可选)您还可以指定一个附加参数:


basename- 用于所创建的 URL名称的基础。如果未设置,则将根据视图集的属性(如果有)自动生成基名。请注意,如果视图集不包含属性,则必须在注册视图集时进行设置。

上面的示例将生成以下 URL 模式:


网址模式: 名称:^users/$‘user-list’

网址模式: 名称:^users/{pk}/$‘user-detail’

网址模式: 名称:^accounts/$‘account-list’

网址模式: 名称:^accounts/{pk}/$‘account-detail’

1.2 合并使用

router = routers.SimpleRouter()
router.register(r'users', UserViewSet)
router.register(r'accounts', AccountViewSet)
urlpatterns = [
    path('forgot-password/', ForgotPasswordFormView.as_view()),
]
urlpatterns += router.urls
urlpatterns = [
    path('forgot-password', ForgotPasswordFormView.as_view()),
    path('', include(router.urls)),
]
urlpatterns = [
    path('forgot-password/', ForgotPasswordFormView.as_view()),
    path('api/', include((router.urls, 'app_name'), namespace='instance_name')),
]

1.3 额外操作的路由

视图集可以通过使用装饰器修饰方法来标记用于布线的额外操作。这些额外的操作将包含在生成的路由中。例如,给定类上的方法:action()


from myapp.permissions import IsAdminOrIsSelf
from rest_framework.decorators import action
class UserViewSet(ModelViewSet):
    ...
    @action(methods=['post'], detail=True, permission_classes=[IsAdminOrIsSelf])
    def set_password(self, request, pk=None):
        ...

将生成以下路由:


网址模式:^users/{pk}/set_password/$

网址名称:'user-set-password'

默认情况下,URL 模式基于方法名称,URL 名称是方法名称和带连字符的方法名称的组合。如果不想为这两个值中的任何一个使用默认值,则可以改为向装饰器提供 and 参数。


例如,如果要将自定义操作的 URL 更改为 ,则可以编写:^users/{pk}/change-password/$


from myapp.permissions import IsAdminOrIsSelf
from rest_framework.decorators import action
class UserViewSet(ModelViewSet):
    ...
    @action(methods=['post'], detail=True, permission_classes=[IsAdminOrIsSelf],
            url_path='change-password', url_name='change_password')
    def set_password(self, request, pk=None):
        ...

上面的示例现在将生成以下 URL 模式:


网址路径:^users/{pk}/change-password/$

网址名称:'user-change_password'

注意点:


默认情况下,创建的 URL 会附加尾部斜杠。可以通过在实例化路由器时将参数设置为来修改此行为。例如:


router = SimpleRouter(trailing_slash=False)

尾随斜杠在 Django 中是约定俗成的,但在其他一些框架(如 Rails)中默认不使用。你选择使用哪种风格很大程度上取决于你的偏好,尽管一些javascript框架可能会期望特定的路由风格。


路由器将匹配包含除斜杠和句点字符之外的任何字符的查找值。对于限制性更强(或宽松)的查找模式,请在视图集上设置属性。例如,可以将查找限制为有效的 UUID:


class MyModelViewSet(mixins.RetrieveModelMixin, viewsets.GenericViewSet):
    lookup_field = 'my_model_id'
    lookup_value_regex = '[0-9a-f]{32}'

2.DefaultRouter

此路由器与上述路由器类似,但还包含默认 API 根视图,该视图返回包含指向所有列表视图的超链接的响应。它还为可选样式格式后缀生成路由。


from rest_framework import routers
router = routers.DefaultRouter()
router.register(r'users', UserViewSet)
router.register(r'accounts', AccountViewSet)
urlpatterns = router.urls

与 URL 路由上的尾部斜杠一样,可以通过在实例化路由器时将参数设置为 来删除。


router = DefaultRouter(trailing_slash=False)

相关文章
|
2月前
|
存储 Java 数据处理
(numpy)Python做数据处理必备框架!(一):认识numpy;从概念层面开始学习ndarray数组:形状、数组转置、数值范围、矩阵...
Numpy是什么? numpy是Python中科学计算的基础包。 它是一个Python库,提供多维数组对象、各种派生对象(例如掩码数组和矩阵)以及用于对数组进行快速操作的各种方法,包括数学、逻辑、形状操作、排序、选择、I/0 、离散傅里叶变换、基本线性代数、基本统计运算、随机模拟等等。 Numpy能做什么? numpy的部分功能如下: ndarray,一个具有矢量算术运算和复杂广播能力的快速且节省空间的多维数组 用于对整组数据进行快速运算的标准数学函数(无需编写循环)。 用于读写磁盘数据的工具以及用于操作内存映射文件的工具。 线性代数、随机数生成以及傅里叶变换功能。 用于集成由C、C++
344 1
|
2月前
|
Java 数据处理 索引
(Pandas)Python做数据处理必选框架之一!(二):附带案例分析;刨析DataFrame结构和其属性;学会访问具体元素;判断元素是否存在;元素求和、求标准值、方差、去重、删除、排序...
DataFrame结构 每一列都属于Series类型,不同列之间数据类型可以不一样,但同一列的值类型必须一致。 DataFrame拥有一个总的 idx记录列,该列记录了每一行的索引 在DataFrame中,若列之间的元素个数不匹配,且使用Series填充时,在DataFrame里空值会显示为NaN;当列之间元素个数不匹配,并且不使用Series填充,会报错。在指定了index 属性显示情况下,会按照index的位置进行排序,默认是 [0,1,2,3,...] 从0索引开始正序排序行。
277 0
|
2月前
|
Java 数据挖掘 数据处理
(Pandas)Python做数据处理必选框架之一!(一):介绍Pandas中的两个数据结构;刨析Series:如何访问数据;数据去重、取众数、总和、标准差、方差、平均值等;判断缺失值、获取索引...
Pandas 是一个开源的数据分析和数据处理库,它是基于 Python 编程语言的。 Pandas 提供了易于使用的数据结构和数据分析工具,特别适用于处理结构化数据,如表格型数据(类似于Excel表格)。 Pandas 是数据科学和分析领域中常用的工具之一,它使得用户能够轻松地从各种数据源中导入数据,并对数据进行高效的操作和分析。 Pandas 主要引入了两种新的数据结构:Series 和 DataFrame。
440 0
|
2月前
|
Java 数据处理 索引
(numpy)Python做数据处理必备框架!(二):ndarray切片的使用与运算;常见的ndarray函数:平方根、正余弦、自然对数、指数、幂等运算;统计函数:方差、均值、极差;比较函数...
ndarray切片 索引从0开始 索引/切片类型 描述/用法 基本索引 通过整数索引直接访问元素。 行/列切片 使用冒号:切片语法选择行或列的子集 连续切片 从起始索引到结束索引按步长切片 使用slice函数 通过slice(start,stop,strp)定义切片规则 布尔索引 通过布尔条件筛选满足条件的元素。支持逻辑运算符 &、|。
183 0
|
Python
python:教学工具:随机点名提问答卷
开发需求:一共x道题目,给y个学生抓阄答题.
2024 0
|
3月前
|
数据采集 机器学习/深度学习 人工智能
Python:现代编程的首选语言
Python:现代编程的首选语言
312 102
|
3月前
|
数据采集 机器学习/深度学习 算法框架/工具
Python:现代编程的瑞士军刀
Python:现代编程的瑞士军刀
340 104
|
3月前
|
人工智能 自然语言处理 算法框架/工具
Python:现代编程的首选语言
Python:现代编程的首选语言
271 103
|
3月前
|
机器学习/深度学习 人工智能 数据挖掘
Python:现代编程的首选语言
Python:现代编程的首选语言
205 82
|
2月前
|
Python
Python编程:运算符详解
本文全面详解Python各类运算符,涵盖算术、比较、逻辑、赋值、位、身份、成员运算符及优先级规则,结合实例代码与运行结果,助你深入掌握Python运算符的使用方法与应用场景。
199 3

推荐镜像

更多