Django 基础（6）-路由Routers-SimpleRouter-DefaultRouter以及 action装饰器

骑猪看日落 2022-09-04 00:58 13阅读 0赞

### 文章目录 ###

*  一、路由Routers
 *  二、action装饰器
 *   *  视图集中附加action的声明
 *  三、路由router形成URL的方式
 *  四、总结
 *  五、参考

# 一、路由Routers #

对于视图集ViewSet，我们除了可以自己手动指明请求方式与动作action之间的对应关系外，还可以使用Routers来帮助我们快速实现路由信息。

REST framework提供了两个router

*  SimpleRouter
 *  DefaultRouter

使用方法: 在urls.py中定义路由

from rest_framework.routers import DefaultRouter
    # 定义视图集的路由
    router = DefaultRouter()
    router.register(r'books',new_views.BookInfoViewSet,base_name='book')
    # 将试图集的路由添加到urlpattens
    urlpatterns += router.urls

或

from rest_framework import routers
     
    router = routers.SimpleRouter()
    router.register(r'books', BookInfoViewSet, base_name='book')

*  prefix 该视图集的路由前缀
 *  viewset 视图集
 *  base\_name 路由名称的前缀

# 二、action装饰器 #

## 视图集中附加action的声明 ##

action装饰器可以接收两个参数：

*  methods: 声明该action对应的请求方式，列表传递
 *  detail: 声明该action的路径是否与单一资源对应，及是否是xxx//action方法名/
    
     *  True 表示路径格式是xxx//action方法名/
     *  False 表示路径格式是xxx/action方法名/

from rest_framework.decorators import action  
    # 追加action:返回书记的倒叙地0个书籍的信息
        @action(methods=['get'],detail=False)
        def latest(self, request):
            """ # 追加action 修改图书的阅读数量 @action(methods=['put'],detail=True) def read(self, request, pk): """

# 三、路由router形成URL的方式 #

1） SimpleRouter  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ludGhhdA_size_16_color_FFFFFF_t_70]  
2）DefaultRouter  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ludGhhdA_size_16_color_FFFFFF_t_70 1]  
DefaultRouter与SimpleRouter的区别是，DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据。

# 四、总结 #

*  一般我们使用SimpleRouter就行。
 *  @action 的detail 其中的pk 是视图方法参数
    
     *  True 表示路径格式是xxx//action方法名/
     *  False 表示路径格式是xxx/action方法名/

视图层方法demo：

@action(methods=['post'], detail=True)
        def delete_token(self, request, pk):
            token = Tokens.objects.get(id=pk)
            token.delete()
            return Response("删除成功")

# 五、参考 #

Django-路由Routers-SimpleRouter-DefaultRouter的使用  
参考URL: https://blog.csdn.net/Odyssues\_lee/article/details/80896033

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ludGhhdA_size_16_color_FFFFFF_t_70]: /images/20220829/ce7d166ee7f74c4285c01affd21741a0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ludGhhdA_size_16_color_FFFFFF_t_70 1]: /images/20220829/29a269b1c5054c10b04702fa93bc36d1.png