DRF路由+装饰器+RESTful

文章介绍了如何在DjangoRestFramework(DRF)中使用DefaultRouter创建路由,并通过decorator添加额外的HTTP方法。RESTful是一种软件架构风格,强调资源的唯一标识符(URI)和HTTP方法(GET,POST,PUT,DELETE等)来操作资源。文章还讨论了RESTfulAPI的关键原则,包括资源、无状态、响应格式和缓存机制。

DefaultRouter
python
from rest_framework import routers

router = routers.DefaultRouter()
router.register(r'users', UserViewSet)
router.register(r'accounts', AccountViewSet)

urlpatterns = router.urls

这样就可以自动生成如下路由:

^users/$    # list
^users/{pk}/$   # retrieve

^accounts/$   # list 
^accounts/{pk}/$ # retrieve

这是app_name.urls

 这是主urls

只需要在urlpatterns加上app_name.urls

 路由地址就为 /api/bbs/topic/

drf+装饰器,

可以在GET、POST这些方法都已要使用增加新的方法

2.@action(methods=None, detail=None, url_path=None, url_name=None, **kwargs)
methods:此操作响应的HTTP方法名称的列表。默认为“get”。
detail:必需。确定此操作是否适用于实例/细节请求或集合/列表请求。
url_path:定义此操作的url段。默认为装饰的方法的名称。
url_name:定义此操作的内部(reverse)url名称。默认为用下划线修饰的方法的名称替换为破折号。
kwargs:要在视图上设置的其他属性。这个可以用重写viewset level*\u classes设置,相当于“@renderer_classes”等修饰符如何为函数工作-基于API视图。

from rest_framework.decorators import action

@action(methods=['get'], detail=False)
def get_user_list(self, request):
    return Response(res, status=status.HTTP_200_OK)

@action(methods=['get'], detail=True)
 def get_user_detail(self, request, pk):
     return Response(data, status=status.HTTP_200_OK)

3.访问路由
xxx/get_user_list
xxx/pk/get_user_detail

example

 如 我在这个类视图已经写有PUT方法了,我用装饰器增加了一个url与我原有的PUT方法不会重叠。且都在一个类视图下。

RESTful是一种软件架构风格和设计原则,用于构建分布式网络应用程序和Web服务。它是"Representational State Transfer"(表现层状态转化)的缩写,是由Roy Fielding在他的博士论文中首次提出的。

RESTful风格的设计原则旨在使API简单、可伸缩、易于理解和使用。它主要依赖于HTTP协议的基本方法(GET、POST、PUT、PATCH、DELETE等)来对资源进行操作,并使用URL表示资源的层次结构。

以下是RESTful风格的一些主要特点和原则:

  1. 资源:在RESTful架构中,资源是Web服务的核心,每个资源都有一个唯一的标识符(URI)来表示它。资源可以是数据对象、图片、视频等。

  2. HTTP方法:RESTful API使用HTTP方法(GET、POST、PUT、PATCH、DELETE等)来执行对资源的不同操作。每个HTTP方法都对应于特定的操作,例如GET用于获取资源,POST用于创建资源,PUT用于更新资源,DELETE用于删除资源。

  3. URL:URL用于表示资源和资源之间的层次结构。资源的唯一标识符通常由URL的路径部分表示。

  4. 状态无关:RESTful API是无状态的,即服务器不保存客户端的状态信息。每个请求都应该包含足够的信息,以便服务器理解请求的意图。

  5. 响应格式:RESTful API通常以JSON或XML格式返回数据,这是一种常见的数据交换格式。

  6. 缓存:RESTful API支持缓存机制,使得客户端可以缓存响应以提高性能和减少网络流量。

  7. 无连接:RESTful API是无连接的,客户端和服务器之间的通信是临时的,每个请求都是独立的。

RESTful风格的设计使得API易于理解和使用,使客户端和服务器之间的通信变得简单和直观。它已成为现代Web应用程序和Web服务的主流设计范式。

<think>嗯,用户想了解Django REST framework(DRF)中的路由对照表。好的,首先我需要回忆一下DRF路由机制。记得DRF提供了DefaultRouter和SimpleRouter这两个类来自动生成URL路由,这样可以简化视图集的URL配置。 首先,用户提到的“路由对照表”可能是指这些自动生成的路由规则。需要解释DefaultRouter和SimpleRouter的区别。DefaultRouter会生成包括API根视图和默认的格式后缀,而SimpleRouter更基础,没有那些额外的功能。然后,可能需要详细说明注册视图集的过程,比如使用router.register()方法,以及生成的路由URL模式。 然后,用户可能需要具体的例子来理解。比如,创建一个路由器实例,注册一个视图集,然后展示生成的URL路径。例如,对于UserViewSet,使用SimpleRouter可能会生成/users/和/users/{pk}/这两个路径,分别对应list和detail操作。 接下来,可能需要提到视图集中的动作(actions)如何映射到HTTP方法。例如,list对应GET,create对应POST,retrieve对应GET单个实例,update对应PUT,partial_update对应PATCH,destroy对应DELETE。此外,如果用户使用了自定义动作,比如用@action装饰器,那么这些动作也会生成额外的路由,比如/users/{pk}/activate/。 还需要说明不同的路由类生成的路由有何不同。比如DefaultRouter会多一个.api的后缀,以及根视图,而SimpleRouter则更简洁。此外,格式后缀的处理,比如.json是否启用,取决于include的参数。 另外,用户可能想知道如何自定义路由,比如修改URL路径中的前缀或查找字段,或者调整映射关系。可能需要提到如何通过视图集的basename参数来覆盖默认的基名称,或者使用@action装饰器的参数来改变URL路径。 最后,总结一下使用DRF路由的好处,比如减少手动编写URL配置的工作量,保持一致性,以及便于维护。同时提醒用户如果遇到复杂需求,可能需要自定义路由或结合其他方法。 在组织回答的时候,要确保结构清晰,分点说明,可能用步骤式的方式解释注册和使用路由器的过程。同时要注意使用正确的中文术语,避免技术术语的混淆,必要时给出代码示例,但按照系统级指令,数学公式和代码可能需要用特定格式,不过这里主要是代码示例,可能不需要LaTeX,但需要正确展示。</think>在Django REST framework (DRF)中,路由对照表主要涉及如何将视图集(ViewSet)的`actions`映射到具体的URL路径。以下是逐步说明: --- ### **一、DRF路由核心机制** DRF通过`SimpleRouter`和`DefaultRouter`类自动生成路由,将视图集中的方法(如`list`, `create`等)与HTTP方法及URL路径匹配。 --- ### **二、路由对照表示例** 以`SimpleRouter`为例,注册视图集后生成的典型路由如下: ```python # 创建路由实例 from rest_framework.routers import SimpleRouter router = SimpleRouter() # 注册视图集 router.register('users', UserViewSet, basename='user') # 生成的路由对照表 urlpatterns = [ path('', include(router.urls)), ] ``` #### **生成的路由对照表** | URL路径 | HTTP方法 | 视图集方法 | 作用 | |------------------|----------|-------------|-------------------| | `/users/` | GET | `list` | 获取列表 | | `/users/` | POST | `create` | 创建新对象 | | `/users/{pk}/` | GET | `retrieve` | 获取单个对象 | | `/users/{pk}/` | PUT | `update` | 全量更新对象 | | `/users/{pk}/` | PATCH | `partial_update` | 部分更新对象 | | `/users/{pk}/` | DELETE | `destroy` | 删除对象 | --- ### **三、DefaultRouter vs SimpleRouter** | 特性 | SimpleRouter | DefaultRouter | |---------------------|----------------------------|---------------------------------| | API根视图 | ❌ 不生成 | ✅ 生成根视图(列出所有路由) | | 格式后缀(.json等) | ❌ 默认不启用 | ✅ 支持后缀如`.json`, `.api` | | 路由复杂性 | 更简单 | 包含额外功能 | --- ### **四、自定义路由行为** #### 1. 修改URL路径参数 ```python router.register(r'custom-users', UserViewSet, basename='user') # 路径变为 /custom-users/ ``` #### 2. 自定义`@action`扩展路由 在视图集中添加自定义方法: ```python class UserViewSet(ModelViewSet): @action(detail=True, methods=['post']) def activate(self, request, pk=None): # 自定义逻辑 pass ``` 生成路由: ``` /users/{pk}/activate/ → POST → activate() ``` #### 3. 修改URL查找字段 通过`lookup_field`和`lookup_url_kwarg`: ```python class UserViewSet(ModelViewSet): lookup_field = 'uuid' # 模型字段 lookup_url_kwarg = 'id' # URL参数名 ``` 生成路径: ``` /users/{id}/ → 使用uuid字段查找对象 ``` --- ### **五、核心优势** - **自动化映射**:减少手动编写URL配置的工作量 - **一致性**:统一RESTful接口风格 - **可扩展性**:通过`@action`轻松添加非标准操作 --- ### **六、注意事项** - 使用`basename`避免视图集命名冲突 - 复杂业务逻辑可能需要手动配置`urlpatterns` - 可通过`Router.urls`查看生成的所有路由 如果需要更深度定制,可继承`BaseRouter`类实现自定义路由逻辑。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值