Class-based Views
REST框架提供了一个APIView类,它是Django中View类的子类。
APIView 类和常规的View类有以下几个方面的不同:
- 传递给处理程序方法的请求将是REST框架的请求实例,而不是Django的HttpRequest实例。
- 处理方法返回的是REST框架的Response而不是Django的HttpResponse。该视图管理content negotiation,并根据响应设置正确的渲染器。
- 任何APIException异常将被捕获并被调解为适当的响应。
- 传入请求将被认证,并且在将请求发送给处理程序方法之前,将运行适当的权限 and/or throttle 检查。
使用APIView类与使用常规的View类一样,像往常一样,传入的请求会调度适当的处理程序方法,如.get()或.post()。 另外,可以在控制API策略的各个方面的类上设置许多属性。
例如:
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import authentication, permissions
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)
API policy attributes
以下属性控制API视图的可插入方面。
.renderer_classes
.parser_classes
.authentication_classes
.throttle_classes
.permission_classes
.content_negotiation_class
API policy instantiation methods
REST框架使用以下方法实例化各种可插拔API策略。 通常不需要重写这些方法。
.get_renderers(self)
.get_parsers(self)
.get_authenticators(self)
.get_throttles(self)
.get_permissions(self)
.get_content_negotiator(self)
.get_exception_handler(self)
API policy implementation methods
调度处理程序方法之前调用以下方法。
.check_permissions(self, request)
.check_throttles(self, request)
.perform_content_negotiation(self, request, force=False)
Dispatch methods
以下方法直接由视图的.dispatch()方法调用。 这些执行任何需要在调用诸如.get(),.post(),put(),patch()和.delete()之类的处理程序方法之前或之后发生的任何操作。
.initial(self,request,* args,** kwargs)
执行在调用处理程序方法之前需要执行的任何操作。此方法用于执行权限和限制,并执行 content negotiation。通常不需要覆盖此方法。
.handle_exception(self,exc)
处理程序方法抛出的任何异常都将传递给此方法,该方法返回一个响应实例,或重新引发异常。
默认实现处理rest_framework.exceptions.APIException的任何子类,以及Django的Http404和PermissionDenied异常,并返回适当的错误响应。
如果您需要自定义您的API返回的错误响应,则应该对此方法进行子类化。
.initialize_request(self,request,* args,** kwargs)
确保传递给handler方法的请求对象是Request的一个实例,而不是通常的Django HttpRequest。
通常不需要覆盖此方法。
.finalize_response(self,request,response,* args,** kwargs)
确保从处理程序方法返回的任何Response对象将被渲染为content negotiation确定的正确内容类型。
通常不需要覆盖此方法。
Function Based Views
REST框架还允许你使用基于函数的常规视图。 它提供了一组简单的装饰器,用于包装基于函数的视图,以确保它们接收到Request(而不是通常的Django HttpRequest)的实例,并允许它们返回一个Response(而不是Django HttpResponse),并允许你配置请求如何被处理。
@api_view()
Signature: @api_view(http_method_names=['GET'], exclude_from_schema=False)
这个功能的核心是api_view装饰器,它包含你的视图应该响应的HTTP方法的列表。 例如,这是你如何编写一个非常简单的视图,只需手动返回一些数据:
from rest_framework.decorators import api_view
@api_view()
def hello_world(request):
return Response({"message": "Hello, world!"})
此视图将使用settings中指定的默认渲染器,解析器,验证类等。
默认情况下只接受GET方法。 其他方法将以“405 Method Not Allowed”作为响应。 要更改此行为,请指定视图允许的方法,如下所示:
@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!"})
你还可以使用exclude_from_schema参数将API视图标记为从任何auto-generated schema中省略:
@api_view(['GET'], exclude_from_schema=True)
def api_docs(request):
...
API policy decorators
要覆盖默认settings,REST框架提供了一组可以添加到您的视图中的其他装饰器。 这些必须在(以下)@api_view装饰器之后。 例如,要创建一个使用 throttle 确保每天只能由特定用户调用一次的视图,请使用@throttle_classes装饰器,传递throttle类列表:
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(...)
这些装饰器中的每一个都采用一个参数,它必须是列表或元组元素。
View schema decorator
要覆盖基于函数的视图的默认模式生成,您可以使用@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!"})