DjangoDRF@action装饰器-6ren

DjangoDRF@action装饰器

转载作者：撒哈拉更新时间：2024-07-17 13:00:39

@action 装饰器在Django REST Framework (DRF) 中非常有用，它可以帮助你在ViewSet中创建自定义的动作，而不仅仅是依赖标准的CRUD操作（Create, Read, Update, Delete）。以下是 @action 装饰器的一些常见用法:

1. 创建自定义集合动作

detail=False 表示这个动作是针对整个集合的。例如，你可以创建一个获取所有用户统计信息的动作:

from rest_framework.decorators import action
from rest_framework.response import Response
from rest_framework import viewsets

class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer

    @action(detail=False, methods=['get'])
    def statistics(self, request):
        user_count = User.objects.count()
        return Response({'user_count': user_count})

2. 创建自定义实例动作

detail=True 表示这个动作是针对单个实例的。例如，你可以创建一个标记用户为活跃的动作:

from rest_framework.decorators import action
from rest_framework.response import Response
from rest_framework import viewsets

class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer

    @action(detail=True, methods=['post'])
    def activate(self, request, pk=None):
        user = self.get_object()
        user.is_active = True
        user.save()
        return Response({'status': 'user activated'})

3. 支持多种HTTP方法

你可以指定动作支持的HTTP方法。例如，你可以创建一个既支持GET又支持POST的动作:

from rest_framework.decorators import action
from rest_framework.response import Response
from rest_framework import viewsets

class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer

    @action(detail=False, methods=['get', 'post'])
    def custom_action(self, request):
        if request.method == 'GET':
            return Response({'message': 'This is a GET request'})
        elif request.method == 'POST':
            data = request.data
            return Response({'message': 'This is a POST request', 'data': data})

4. 指定URL路径和名称

你可以指定自定义动作的URL路径和名称。例如:

from rest_framework.decorators import action
from rest_framework.response import Response
from rest_framework import viewsets

class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer

    @action(detail=True, methods=['post'], url_path='set-password', url_name='set_password')
    def set_password(self, request, pk=None):
        user = self.get_object()
        new_password = request.data.get('password')
        user.set_password(new_password)
        user.save()
        return Response({'status': 'password set'})

5. 使用权限和认证

你可以为自定义动作设置权限和认证。例如:

from rest_framework.decorators import action
from rest_framework.response import Response
from rest_framework import viewsets
from rest_framework.permissions import IsAuthenticated

class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer

    @action(detail=True, methods=['get'], permission_classes=[IsAuthenticated])
    def profile(self, request, pk=None):
        user = self.get_object()
        serializer = self.get_serializer(user)
        return Response(serializer.data)

6. 返回自定义响应

你可以在自定义动作中返回任何类型的响应。例如，文件下载、重定向等:

from rest_framework.decorators import action
from rest_framework.response import Response
from rest_framework import viewsets
from django.http import FileResponse

class DocumentViewSet(viewsets.ModelViewSet):
    queryset = Document.objects.all()
    serializer_class = DocumentSerializer

    @action(detail=True, methods=['get'])
    def download(self, request, pk=None):
        document = self.get_object()
        file_handle = document.file.open()
        response = FileResponse(file_handle, content_type='application/pdf')
        response['Content-Disposition'] = f'attachment; filename="{document.filename}"'
        return response

总结

@action 装饰器为Django REST Framework中的ViewSet提供了极大的灵活性，允许你在标准的CRUD操作之外添加自定义逻辑和功能。这使得你能够创建更加丰富和复杂的API端点，满足具体的业务需求.

最后此篇关于DjangoDRF@action装饰器的文章就讲到这里了,如果你想了解更多关于DjangoDRF@action装饰器的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！。

文章推荐：基于Java+SpringBoot+vue+element助农平台设计和实现

文章推荐：可视化—gojs超多超实用经验分享(三)

文章推荐： iOS开发基础109-网络安全

文章推荐：解码xsync的map实现

WPF:装饰 ViewModel？
我有这些 ViewModel:RecordViewModel、ComponentViewModel，其中 RecordViewModel 本质上是几个 ComponentViewModel 的容器。
Angularjs - 装饰 Controller
我正在尝试为我的 Controller 设置一个装饰器。我的目的是在我的应用程序中的所有 Controller 中引入一些常见的行为。我已将其配置为在 Angular 1.2.x 中工作，但从 1.
java - 装饰 JFreeChart
我想用角上的时间戳装饰我生成的所有 JFreeCharts。 JFreeChart 框架中是否有一种方法可以在生成图表后在图像上绘制？编辑:请注意，这些图表是在后台线程中生成并通过 servlet
grails - 如何系统地添加(装饰)一些要记录的数据
在grails应用程序中，我想用自定义数据装饰每个日志。当前的需要只是在日志消息前添加当前用户名我对如何解决此问题有一些想法: -Adding custom field to log4j patte
polymer - 装饰中的元素
我有一个form-el，它只是一个容器，必须将所有子元素包装在具有特定类的div 中。我希望允许 from-el 来包装它们，而不是在每个表单元素中重复这个 div 。我可以循环所有元素并将它们包装在
python - 装饰 Python 类方法的最佳方式是什么？
我遵循以下约定来装饰 Python 类中的某些方法。我想知道是否有一些更好的方法可以做到同样的事情。我的方法看起来当然不太好；对原始成员函数的调用看起来一点也不直观。 from threading i
c# - 寻找一个属性(装饰)来提及与自动映射器一起使用的源属性名称
我的 DTO 看起来像这样 public class SomeDTO { public string last_name{ get; set; } public string ac
c# - 装饰 .NET 程序集
这可能是一个远景，但 .NET 的灵 active 一直让我惊叹不已，所以开始吧。我正在开发一个 MVC 应用程序，它需要在一组程序集中搜索派生自公共(public)基类的类类型。即我有几个程序集
javascript - 装饰 $errorProvider 时的循环引用
在我正在进行的项目中，我正在按照项目负责人的要求实现开发人员通知系统。它的工作方式是，如果发生前端错误，开发团队会收到一封错误电子邮件。但是，在我当前的实现中，我似乎有以下循环依赖: $rootSc
java - 装饰、取消装饰 JInternalFrame
我需要一些关于如何取消装饰和装饰 JInternalFrame 的帮助。我的框架类是这样的: package com; import java.awt.BorderLayout; import jav
java - 装饰 Java 的可调用对象以添加行为
假设我们有可能需要长时间运行的任务: public class LongRunningTask { public ReturnType doSomething() { ...
javascript - 装饰 React 组件以添加生命周期方法
我正在尝试创建一个装饰器方法，它将一些默认的生命周期方法添加到 react 组件中。我的目标是向组件中添加一些默认功能，例如，所有组件都应该能够在 componentWillMount 上执行特定操作
python - 装饰 DBUS 方法
我正在尝试将 DBUS 的异步方法调用与 Twisted 的 Deferred 相结合，但我在调整常用的 DBUS 服务方法装饰器来执行此操作时遇到了麻烦。要使用 DBUS 异步回调方法，您需要:
javascript - Qooxdoo中的餐 table 装饰
是否可以设置表格中一行的背景颜色？当条件适用时，我需要突出显示一行。效果为 ...我可以在其中指定“字体”属性。 (我需要突出显示整行)。最佳答案您必须子类化 qooxdoo 默认行渲染器才能做到
java - 动态显示和隐藏 JFrame 装饰
我正在开发一个具有不同视角的基于 Java Swing 的应用程序。对于“主菜单”视角，我不希望装饰窗口 (JFrame)，而在其他视角中，我确实希望装饰窗口。换句话说，我需要动态更 retrofit
C++ 装饰 basic_iostream 类
我想做一些类似下面代码所示的事情: class foo { private: std::fstream* m_stream; public: foo(std::fstream* str
java - 装饰 ObservableList 并保留更改事件的最佳实践
我的数据源提供了一个 ObservableList ，但是对于我的 ListView，我需要一个 ObservableList . A Warning基本上只是字符串的装饰器，添加一个 boolean
c# - 多接口(interface)装饰
我一直在纠结于装饰+接口(interface)。假设我有以下“行为”接口(interface): interface IFlyable { void Fly();} interface ISwimma
ios - UICollectionView 装饰 View
有没有人为 iOS 6 UICollectionView 实现过装饰 View ？不可能查找有关在网络上实现装饰 View 的任何教程。基本上在我的应用程序中，我有多个部分，我只想在每个部分后面显示
javascript - AngularJS:装饰 $http
我有一个简单的 Controller ，例如: function MyController($scope, $http) { ... $http.post(url).success(f

撒哈拉

个人简介

我是一名优秀的程序员,十分优秀！

作者热门文章

滴滴打车优惠券免费领取

全站热门文章

首页

博学

6Ren·AI

商城