标签:force attribute today djang 动作 return 元组 over 情况
Django的基于类的意见是从旧式的观点颇受欢迎。
REST框架提供了一个APIView
类,它的子类Django的View
类。
APIView
类是从正规不同View
类别在以下几个方面:
Request
情况下,不Django的HttpRequest
实例。Response
,而不是Django的,HttpResponse
。该视图将管理内容的谈判和制定的响应正确的渲染。APIException
异常都会被捕获并介导到适当的响应。使用APIView
类是几乎一样使用普通View
类,像往常一样,进入的请求被分发到适当的处理程序方法,例如.get()
或.post()
。此外,一些属性可能对控制API政策的各个方面的类进行设置。
例如:
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import authentication, permissions
from django.contrib.auth.models import User
class ListUsers(APIView):
"""
View to list all users in the system.
* Requires token authentication.
* Only admin users are able to access this view.
"""
authentication_classes = [authentication.TokenAuthentication]
permission_classes = [permissions.IsAdminUser]
def get(self, request, format=None):
"""
Return a list of all users.
"""
usernames = [user.username for user in User.objects.all()]
return Response(usernames)
注:完整的方法,属性,并与Django的REST框架的关系APIView
,GenericAPIView
各种Mixins
,并且Viewsets
可以初步复杂。在这里除了文档中,优等Django的REST框架资源提供了一个可浏览参考,以饱满的方法和属性,为每个Django的REST框架的基于类的意见。
下面的属性控制的API意见可插拔方面。
下面的方法是使用REST框架实例的各种可插拔的API政策。你通常不会需要重写这些方法。
下面的方法分派给处理方法之前被调用。
下面的方法是通过该视图的直接调用.dispatch()
方法。这些执行需要之前或调用处理方法,如之后发生的任何动作.get()
,.post()
,put()
,patch()
和.delete()
。
执行该处理方法被调用之前进行必要的任何行动。该方法用于执行权限和节流,并执行内容协商。
你通常不会需要重写此方法。
通过处理方法抛出的任何异常将被传递给这个方法,它要么返回一个Response
实例,或重新引发异常。
默认实现手柄的任何子类rest_framework.exceptions.APIException
,以及Django的Http404
和PermissionDenied
异常,并返回相应的错误信息。
如果您需要自定义错误响应您的API返回,你应该继承这个方法。
确保所传递给处理程序方法请求对象是一个实例Request
,而不是通常的Django HttpRequest
。
你通常不会需要重写此方法。
确保任何Response
从处理程序方法返回对象将被渲染成正确的内容类型,如由内容协商确定。
你通常不会需要重写此方法。
话说[即基于类的意见]总是出色的解决方案是一个错误。
- 尼克·科格伦
REST框架还可以让你的工作与基于定时功能的看法。它提供了一套简单的装饰是包住功能为本次,以确保他们收到的一个实例Request
(而不是通常的Django HttpRequest
),并允许他们返回Response
(而不是一个Django HttpResponse
),并允许您配置请求的处理。
签名: @api_view(http_method_names=[‘GET‘])
这个功能的核心是api_view
装饰,它采用的方法,你的观点应该做出响应的HTTP列表。例如,这是你会怎么写,只是手动返回一些数据,一个很简单的观点:
from rest_framework.decorators import api_view
@api_view()
def hello_world(request):
return Response({"message": "Hello, world!"})
这种观点将使用默认的渲染器,解析器,认证类等,在指定的设置。
默认情况下,只有GET
方法将被接受。其他方法将与“405不允许的方法”作出回应。要改变这种现象,指定哪些方法视图允许,就像这样:
@api_view(['GET', 'POST'])
def hello_world(request):
if request.method == 'POST':
return Response({"message": "Got some data!", "data": request.data})
return Response({"message": "Hello, world!"})
要覆盖默认设置,REST框架提供了一套可以添加到您的看法更多的装饰。这些一定要来后(下)的@api_view
装饰。例如,要创建一个使用视图油门,以确保它只能通过特定的用户被称为每天一次,使用的@throttle_classes
装饰,通过油门类的列表:
from rest_framework.decorators import api_view, throttle_classes
from rest_framework.throttling import UserRateThrottle
class OncePerDayUserThrottle(UserRateThrottle):
rate = '1/day'
@api_view(['GET'])
@throttle_classes([OncePerDayUserThrottle])
def view(request):
return Response({"message": "Hello for today! See you tomorrow!"})
这些装饰器对应于上设置的属性APIView
的子类,如上所述。
可用的装饰是:
@renderer_classes(...)
@parser_classes(...)
@authentication_classes(...)
@throttle_classes(...)
@permission_classes(...)
所有这些装饰的需要必须是类的列表或元组的一个参数。
要覆盖缺省模式生成的功能为本次你可以使用@schema
装饰。这必须来后(下)的@api_view
装饰。例如:
from rest_framework.decorators import api_view, schema
from rest_framework.schemas import AutoSchema
class CustomAutoSchema(AutoSchema):
def get_link(self, path, method, base_url):
# override view introspection here...
@api_view(['GET'])
@schema(CustomAutoSchema())
def view(request):
return Response({"message": "Hello for today! See you tomorrow!"})
这个装饰采用单个AutoSchema
实例,一个AutoSchema
子类的实例或ManualSchema
作为中所述的实例架构文档。您可以传递None
,以排除架构生成视图。
@api_view(['GET'])
@schema(None)
def view(request):
return Response({"message": "Will not appear in schema!"})
标签:force attribute today djang 动作 return 元组 over 情况
原文地址:https://www.cnblogs.com/pyliuwei/p/12468684.html