「Django REST Framework 框架」Router路由解析和应用举例

àì夳堔傛蜴生んèń 2023-01-10 03:40 47阅读 0赞

### 文章目录 ###

*  内容介绍
 *  Router路由
 *  应用举例

# 内容介绍 #

开发环境为 Python3.6，Django 版本 3.0.x ，REST Framework 版本 3.12.x

全部内容索引目录  
**[看懂Django框架，没有最好只有更好][Django]**

在开发中设计中符合 Restful 风格的 API 路由。

# Router路由 #

**1.SimpleRouter**

# 使用已经定义好的 ModelNameViewSet 注册 URL
    # ---register() 参数---
    # prefix：用于这组路由的 URL 前缀字符串，用于路由匹配
    # viewset：定义的视图集
    
    from rest_framework import routers
    
    router = routers.SimpleRouter()
    router.register(r'apps/modelname', ModelNameViewSet)
    urlpatterns = router.urls

视图集实现了获取列表/获取详情/新增/删除/修改的方法, 定义路由将会解析成

<table> 
 <thead> 
  <tr> 
   <th>URL</th> 
   <th>格式请求</th> 
   <th>方法请求</th> 
   <th>说明视图集方法</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>^article_settings/article$</td> 
   <td>GET</td> 
   <td>获取列表</td> 
   <td>list()</td> 
  </tr> 
  <tr> 
   <td>^article_settings/article/{pk}$</td> 
   <td>GET</td> 
   <td>获取详情</td> 
   <td>retrieve()</td> 
  </tr> 
  <tr> 
   <td>^article_settings/article$</td> 
   <td>POST</td> 
   <td>新增</td> 
   <td>create()</td> 
  </tr> 
  <tr> 
   <td>^article_settings/article/{pk}$</td> 
   <td>PUT</td> 
   <td>更新</td> 
   <td>update()</td> 
  </tr> 
  <tr> 
   <td>^article_settings/article/{pk}$</td> 
   <td>DELETE</td> 
   <td>删除</td> 
   <td>destroy()</td> 
  </tr> 
 </tbody> 
</table>

# 默认情况下路由都需要添加符号 / 作为路由结尾
    # 修改该规则需要修改参数
    router = SimpleRouter(trailing_slash=False)

该路由器生成 URL 的方式

<table> 
 <tbody> 
  <tr> 
   <th>URL Style</th> 
   <th>HTTP Method</th> 
   <th>Action</th> 
   <th>URL Name</th> 
  </tr> 
  <tr> 
   <td>{prefix}/</td> 
   <td>GET</td> 
   <td>list</td> 
   <td>{basename}-list</td> 
  </tr> 
  <tr> 
   <td>POST</td> 
   <td>create</td> 
  </tr> 
  <tr> 
   <td>{prefix}/{url_path}/</td> 
   <td>GET, or as specified by `methods` argument</td> 
   <td>`@action(detail=False)` decorated method</td> 
   <td>{basename}-{url_name}</td> 
  </tr> 
  <tr> 
   <td>{prefix}/{lookup}/</td> 
   <td>GET</td> 
   <td>retrieve</td> 
   <td>{basename}-detail</td> 
  </tr> 
  <tr> 
   <td>PUT</td> 
   <td>update</td> 
  </tr> 
  <tr> 
   <td>PATCH</td> 
   <td>partial_update</td> 
  </tr> 
  <tr> 
   <td>DELETE</td> 
   <td>destroy</td> 
  </tr> 
  <tr> 
   <td>{prefix}/{lookup}/{url_path}/</td> 
   <td>GET, or as specified by `methods` argument</td> 
   <td>`@action(detail=True)` decorated method</td> 
   <td>{basename}-{url_name}</td> 
  </tr> 
 </tbody> 
</table>

**2.include**

# 使用 urlpatterns = router.urls 的方式注册路由对象通常会使用 include 进行路由注册
    # 在 Django 中自定义的视图不需要使用 SimpleRouter 进行注册
    r
    from django.conf.urls import url
    from django.urls import include
    from rest_framework import routers
    
    router = routers.SimpleRouter()
    router.register(r'apps/modelname', ModelNameViewSet)
    
    urlpatterns = [
        ...,  # 其他路由配置
        url(r'^', include(router.urls)),
    ]

**3.路由绑定其他操作**

# 对访问数据的配置可能有以下几个方法处理
    # -GET：获取数据详情/列表
    # -PUT：修改数据
    # -POST：新增数据
    # -DLETE：删除数据
    
    # 默认情况下你生成的 URL 是根据函数名称生成
    # 你也可以通过 url_name 和 url_path 制定路由的后缀名称
    # 也可以通过 permission_classes 来制定访问权限
    
    from rest_framework.decorators import action
    from rest_framework.viewsets import ModelViewSet
    
    class UserViewSet(ModelViewSet):
        ...
        @action(methods=['post'], detail=True)
        def reset(self, request, pk=None):
            ...

**4.DefaultRouter**

# 与 SimpleRouter 类似
    # 但会包含一个默认的 API 根视图，返回一个包含所有列表视图的超链接响应数据
    # 该路由的路径也会使用 / 结尾
    # 可以用 trailing_slash=False 修改
    router = DefaultRouter(trailing_slash=False)

<table> 
 <tbody> 
  <tr> 
   <th>URL Style</th> 
   <th>HTTP Method</th> 
   <th>Action</th> 
   <th>URL Name</th> 
  </tr> 
  <tr> 
   <td>[.format]</td> 
   <td>GET</td> 
   <td>automatically generated root view</td> 
   <td>api-root</td> 
  </tr> 
  <tr> 
   <td>{prefix}/[.format]</td> 
   <td>GET</td> 
   <td>list</td> 
   <td>{basename}-list</td> 
  </tr> 
  <tr> 
   <td>POST</td> 
   <td>create</td> 
  </tr> 
  <tr> 
   <td>{prefix}/{url_path}/[.format]</td> 
   <td>GET, or as specified by `methods` argument</td> 
   <td>`@action(detail=False)` decorated method</td> 
   <td>{basename}-{url_name}</td> 
  </tr> 
  <tr> 
   <td>{prefix}/{lookup}/[.format]</td> 
   <td>GET</td> 
   <td>retrieve</td> 
   <td>{basename}-detail</td> 
  </tr> 
  <tr> 
   <td>PUT</td> 
   <td>update</td> 
  </tr> 
  <tr> 
   <td>PATCH</td> 
   <td>partial_update</td> 
  </tr> 
  <tr> 
   <td>DELETE</td> 
   <td>destroy</td> 
  </tr> 
  <tr> 
   <td>{prefix}/{lookup}/{url_path}/[.format]</td> 
   <td>GET, or as specified by `methods` argument</td> 
   <td>`@action(detail=True)` decorated method</td> 
   <td>{basename}-{url_name}</td> 
  </tr> 
 </tbody> 
</table>

**5.自定义路由器（不常用）**

# 需要自定义 URL 格式的时候使用，实现自定义路由是将现有路由作为子类之一
    # 其 .routes 属性是 Route 的命名元组的列表数据
    # 功能是用于模板化将映射到每个视图集的 URL 模式

<table> 
 <thead> 
  <tr> 
   <th align="center">Route 元祖参数</th> 
   <th>解释说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">url</td> 
   <td>代表需要路由的 URL 字符串，例如：用于这组路由器的前缀字符串 “{prefix}”；用于单个实例匹配的字符串"{lookup}“的ID；根据 trailing_slash 参数制定结尾字符”{trailing_slash}"</td> 
  </tr> 
  <tr> 
   <td align="center">mapping</td> 
   <td>HTTP 方法名称到视图方法的映射</td> 
  </tr> 
  <tr> 
   <td align="center">name</td> 
   <td>reverse 呼叫用使用的 URL 名称，例如：用于创建 URL 名称的基础字符"{basename}"</td> 
  </tr> 
  <tr> 
   <td align="center">initkwargs</td> 
   <td>实例化视图需要的参数字典</td> 
  </tr> 
 </tbody> 
</table>

**6.自定义解析路线**

# 使用 @action 的时候你也可以自定义路由方式
    # .routes 的列表是包含 DynamicRoute 命名的元组
    # 将 detail 参数设置为适用于基于列表的路由和基于详细信息的路由

<table> 
 <thead> 
  <tr> 
   <th align="center">detail 参数</th> 
   <th>解释说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">url</td> 
   <td>一个代表路由 URL 的字符串，可能会包含和 Route 相同格式的字符串，并接受一个 “{url_path}” 格式的字符串</td> 
  </tr> 
  <tr> 
   <td align="center">name</td> 
   <td>reverse 调用中使用的 URL 名称, 例如：用于创建 URL 的名称基础"{basename}"；提供给 @action 的 “{url_name}”</td> 
  </tr> 
  <tr> 
   <td align="center">initkwargs</td> 
   <td>实例化试图需要的参数字典</td> 
  </tr> 
 </tbody> 
</table>

# 应用举例 #

**1.只读API的路由器，不使用尾部斜杠/**

from rest_framework.routers import Route, DynamicRoute, SimpleRouter
    
    class CustomReadOnlyRouter(SimpleRouter):
        routes = [
            Route(
                url=r'^{prefix}$',
                mapping={ 'get': 'list'},
                name='{basename}-list',
                detail=False,
                initkwargs={ 'suffix': 'List'}
            ),
            Route(
                url=r'^{prefix}/{lookup}$',
                mapping={ 'get': 'retrieve'},
                name='{basename}-detail',
                detail=True,
                initkwargs={ 'suffix': 'Detail'}
            ),
            DynamicRoute(
                url=r'^{prefix}/{lookup}/{url_path}$',
                name='{basename}-{url_name}',
                detail=True,
                initkwargs={ }
            )
        ]

**2.include 应用**

urlpatterns = [
    	......
        # include 各个模块的内容
        path('ArticleSettings/', include("articles.urls")),  # apps.articles
       	......
    ]

**3.应用 url 路由**

from rest_framework.routers import DefaultRouter
    from .views import *
    
    # 自动生成路由方法
    router = DefaultRouter()
    # apps.articles 下的全部路由方法
    router.register('ArticleCategory', ArticleCategoryViewSet, 'ArticleCategory')  # 文章大类路由
    router.register('ArticleItem', ArticleItemViewSet, 'ArticleItem')  # 文章栏目路由
    ......
    
    urlpatterns = [
    ]
    urlpatterns += router.urls

[Django]: https://blog.csdn.net/qq_20288327/article/details/117383454