python测试开发django-rest-framework-63.基于函数的视图(@api_view())

时间:2021-08-27 11:34:44

前言

上一篇讲了基于类的视图,在REST framework中,你也可以使用常规的基于函数的视图。它提供了一组简单的装饰器,用来包装你的视图函数,

以确保视图函数会收到Request(而不是Django一般的HttpRequest)对象,并且返回Response(而不是Django的HttpResponse)对象,同时允许你设置这个请求的处理方式。

基于函数视图@api_view()

函数签名: @api_view(http_method_names=['GET'], exclude_from_schema=False)

此功能的核心是api_view装饰器,它接受视图应该响应的HTTP方法列表的参数。 比如,你可以像这样写一个返回一些数据的非常简单的视图。

先使用django自带的view,获取一个Card表里面的卡号信息:

models.py设计card表

# models.py
class Card(models.Model):
'''银行卡 基本信息 # 作者:上海悠悠,QQ交流群:750815713'''
card_id = models.CharField(max_length=30, verbose_name="卡号", default="")
card_user = models.CharField(max_length=10, verbose_name="姓名", default="")
add_time = models.DateField(auto_now=True, verbose_name="添加时间") class Meta:
verbose_name_plural = '银行卡账户'
verbose_name = "银行卡账户_基本信息" def __str__(self):
return self.card_id

这里没用到权限认证,所以先把setting.py权限相关认证去掉

REST_FRAMEWORK = {
# 权限认证
# 'DEFAULT_PERMISSION_CLASSES': (
# 'rest_framework.permissions.IsAuthenticated', # IsAuthenticated 仅通过认证的用户
# 'rest_framework.permissions.AllowAny', # AllowAny 允许所有用户
# 'rest_framework.permissions.IsAdminUser', # IsAdminUser 仅管理员用户
# 'rest_framework.permissions.IsAuthenticatedOrReadOnly', # IsAuthenticatedOrReadOnly 认证的用户可以完全操作,否则只能get读取
# ),
# 身份认证
'DEFAULT_AUTHENTICATION_CLASSES': (
'rest_framework.authentication.BasicAuthentication',
'rest_framework.authentication.SessionAuthentication',
'rest_framework.authentication.TokenAuthentication', # token认证
)
}

使用@api_view()装饰器编写views.py,先序列化Card类,

from rest_framework.response import Response
from rest_framework.views import APIView
from rest_framework import serializers
from .models import *
from rest_framework.permissions import IsAuthenticated,AllowAny
from rest_framework.decorators import api_view
'''作者:上海悠悠,QQ交流群:750815713''' class CardAPISerializer(serializers.ModelSerializer): # 继承自ModelSerializer类
'''序列化数据的类,根据model表来获取字段'''
class Meta:
model = Card
fields = '__all__' @api_view(['GET', 'POST'])
def card_list_view(request):
'''基于函数式实现get和post请求'''
cards = Card.objects.all()
serializer = CardAPISerializer(cards, many=True)
if request.method == 'GET':
return Response(serializer.data) elif request.method == 'POST':
verify_data = CardAPISerializer(data=request.data)
if verify_data.is_valid():
verify_data.save()
return Response({"message": "create some data!", "data": request.data})
else:
return Response(verify_data.errors)
else:
return Response({"message": "request method mot valid!"})

urls.py设置访问地址

from apiapp import views
from django.conf.urls import url
from rest_framework import routers
from django.conf.urls import include # 作者:上海悠悠,QQ交流群:750815713 urlpatterns = [
url(r'^card_list_view', views.card_list_view), ]

测试接口

访问 http://127.0.0.1:8000/card_list_view,get请求获取列表

python测试开发django-rest-framework-63.基于函数的视图(@api_view())

POST请求访问http://127.0.0.1:8000/card_list_view

python测试开发django-rest-framework-63.基于函数的视图(@api_view())

结果返回

python测试开发django-rest-framework-63.基于函数的视图(@api_view())

查看数据库会新增一条数据

python测试开发django-rest-framework-63.基于函数的视图(@api_view())

token认证与访问权限

如果我们希望只有拿到登录token后,才能访问此接口,那就需要加authentication_classes和permission_classes两个装饰器,先导入

from rest_framework.decorators import api_view, authentication_classes, permission_classes

注意先执行的写在装饰器最下层,装饰器从下往上执行:@authentication_classes>@permission_classes>@api_view

from rest_framework.decorators import api_view, authentication_classes, permission_classes
# 作者:上海悠悠,QQ交流群:750815713 @api_view(['GET', 'POST'])
@permission_classes([IsAuthenticated])
@authentication_classes([TokenAuthentication])
def card_list_view(request):
'''基于函数式实现get和post请求'''
cards = Card.objects.all()
serializer = CardAPISerializer(cards, many=True)
if request.method == 'GET':
return Response(serializer.data) elif request.method == 'POST':
verify_data = CardAPISerializer(data=request.data)
if verify_data.is_valid():
verify_data.save()
return Response({"message": "create some data!", "data": request.data})
else:
return Response(verify_data.errors)
else:
return Response({"message": "request method mot valid!"})

这时候通过get和post访问此接口,就需要带上token,否则出现401

python测试开发django-rest-framework-63.基于函数的视图(@api_view())

如果没有token,状态码为401

python测试开发django-rest-framework-63.基于函数的视图(@api_view())

关于token认证相关知识参考前面这篇python测试开发django-61.权限认证(permission)

除了上面用到的装饰器,其它可用的装饰器有:

  • @renderer_classes(...)
  • @parser_classes(...)
  • @authentication_classes(...)
  • @throttle_classes(...)
  • @permission_classes(...)

    每个装饰器都有一个参数,它必须是一个类列表或者一个类元组。