一、Django ModelViewSet简介
在 Django REST framework 中,ModelViewSet 是一种可以将常见的列表、详细视图、创建、更新、删除等操作组合起来的视图。这样可以帮助我们减少代码量,使代码结构更加清晰。
以下是一个简单的例子:
from rest_framework import viewsets
from .models import MyModel
from .serializers import MyModelSerializer
class MyModelViewSet(viewsets.ModelViewSet):
queryset = MyModel.objects.all()
serializer_class = MyModelSerializer
上述代码中,我们定义了一个 MyModelViewSet,继承自ModelViewSet,它代表了对MyModel模型的基本 CRUD 操作。
二、Django ModelViewSet 认证设置
Django REST framework 提供了一种简单而灵活的方式来设置API的认证规则,通过在ModelViewSet中使用authentication_classes
属性,可以设置认证方式。
下面是一个设置的简单示例:
from rest_framework import viewsets
from rest_framework.authentication import TokenAuthentication
from .models import MyModel
from .serializers import MyModelSerializer
class MyModelViewSet(viewsets.ModelViewSet):
queryset = MyModel.objects.all()
serializer_class = MyModelSerializer
authentication_classes = [TokenAuthentication]
上述代码设置了 Token 认证方式,用户请求 API 时需在 Header 中带有 Token。
三、Django 默认认证设置
如果你的项目中大部分的 API 都使用相同的认证方式,那么你可以在项目设置中进行全局的认证设置,这样可以避免在每个视图中都设置认证方式。
下面是一个设置的简单示例:
# settings.py
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': [
'rest_framework.authentication.TokenAuthentication',
]
}
上述代码设置了项目默认的认证方式为 Token 认证。
四、Django 自定义认证
除了 Django REST framework 提供的认证方式,你也可以自定义认证方式,只需继承BaseAuthentication
类,重写authenticate
方法。
下面是一个自定义认证的简单示例:
from rest_framework import authentication
from rest_framework import exceptions
class MyAuthentication(authentication.BaseAuthentication):
def authenticate(self, request):
token = request.META.get('HTTP_MYTOKEN')
if not token:
return None
if token != 'my_token':
raise exceptions.AuthenticationFailed('认证失败!')
return (token, None)
在这个示例中,我们创建了一个名为 MyAuthentication 的自定义认证类。在 authenticate 方法中,我们检查 header 中是否包含 MYTOKEN ,如果不存在则返回 None,让 Django REST framework 使用其他的认证方式。如果存在,但值不等于 'my_token',则抛出认证失败的异常。
总结起来,Django REST framework 提供了强大而灵活的认证设置,使我们可以在项目中轻松地处理 API 的认证问题。