Django-rest-framework 03(实例:用户注册、超级用户、认证、权限)
时间: 2023-07-10 15:06:30 浏览: 157
Django restframework 框架认证、权限、限流用法示例
在 Django-rest-framework 中,认证和权限是非常重要的概念。本篇文章将介绍如何实现用户注册、超级用户、认证和权限。
1. 用户注册
首先,我们需要在 models.py 文件中创建一个用户模型:
```python
from django.db import models
from django.contrib.auth.models import AbstractUser
class User(AbstractUser):
email = models.EmailField(unique=True)
```
然后,我们需要创建一个序列化器(serializer)来对 User 模型进行序列化和反序列化操作。在 serializers.py 文件中创建以下代码:
```python
from rest_framework import serializers
from .models import User
class UserSerializer(serializers.ModelSerializer):
password = serializers.CharField(write_only=True)
class Meta:
model = User
fields = ('id', 'username', 'email', 'password')
def create(self, validated_data):
user = User.objects.create(
username=validated_data['username'],
email=validated_data['email']
)
user.set_password(validated_data['password'])
user.save()
return user
```
在上面的代码中,我们将密码字段标记为 write_only,这意味着在序列化过程中不会返回该字段的值。在 create 方法中,我们使用 Django 的内置 create_user 方法创建用户。
接下来,我们需要创建一个视图(view)来处理用户注册。在 views.py 中添加以下代码:
```python
from rest_framework import generics
from rest_framework.permissions import AllowAny
from .serializers import UserSerializer
class UserCreateView(generics.CreateAPIView):
queryset = User.objects.all()
serializer_class = UserSerializer
permission_classes = (AllowAny,)
```
在上述代码中,我们使用 generics.CreateAPIView 来创建一个视图,该视图将使用 UserSerializer 进行序列化和反序列化操作。permission_classes 设置为 AllowAny 表示任何人都可以访问该视图。
现在,我们需要在 urls.py 文件中添加以下路由:
```python
from django.urls import path
from .views import UserCreateView
urlpatterns = [
path('users/', UserCreateView.as_view(), name='user_create'),
]
```
现在,你可以通过访问 /users/ 来创建新用户了。
2. 超级用户
在 Django 中,超级用户是一个拥有所有权限的用户。在 Django-rest-framework 中,我们可以使用命令行来创建超级用户。
打开命令行,进入项目目录,然后运行以下命令:
```
python manage.py createsuperuser
```
按照提示输入用户名、电子邮件和密码。完成后,你就可以使用超级用户登录到 Django-rest-framework 管理界面了。
3. 认证
在 Django-rest-framework 中,认证是指确定用户身份的过程。Django-rest-framework 提供了多种认证方式,例如基于 Token 的认证、基于 Session 的认证、OAuth 1/2 认证等。
在本例中,我们将使用基于 Token 的认证。首先,我们需要在 settings.py 文件中添加以下代码:
```python
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': (
'rest_framework.authentication.TokenAuthentication',
),
}
```
在上述代码中,我们将 TokenAuthentication 添加到默认的认证类列表中。
接下来,我们需要在 views.py 文件中创建一个视图来获取用户 Token。添加以下代码:
```python
from rest_framework.authtoken.views import ObtainAuthToken
from rest_framework.authtoken.models import Token
class ObtainTokenView(ObtainAuthToken):
def post(self, request, *args, **kwargs):
response = super(ObtainTokenView, self).post(request, *args, **kwargs)
token = Token.objects.get(key=response.data['token'])
return Response({'token': token.key})
```
在上述代码中,我们从 ObtainAuthToken 继承,然后重写 post 方法来返回令牌的 key 值。
现在,我们需要在 urls.py 文件中添加以下路由:
```python
from django.urls import path
from .views import ObtainTokenView
urlpatterns = [
path('api-token-auth/', ObtainTokenView.as_view(), name='obtain_token'),
]
```
现在,你可以通过访问 /api-token-auth/ 来获取用户的 Token 了。
4. 权限
在 Django-rest-framework 中,权限是指控制用户访问 API 的方式。Django-rest-framework 提供了多种权限类,例如基于用户身份、基于请求方法、基于对象等。
在本例中,我们将使用基于对象的权限。首先,我们需要在 models.py 文件中添加以下代码:
```python
class Post(models.Model):
title = models.CharField(max_length=200)
content = models.TextField()
author = models.ForeignKey(User, on_delete=models.CASCADE)
def __str__(self):
return self.title
```
在上面的代码中,我们创建了一个 Post 模型,它包含标题、内容和作者字段。
接下来,我们需要在 serializers.py 文件中添加以下代码:
```python
class PostSerializer(serializers.ModelSerializer):
class Meta:
model = Post
fields = ('id', 'title', 'content', 'author')
```
在上述代码中,我们创建了一个 PostSerializer,用于对 Post 模型进行序列化和反序列化操作。
接下来,我们需要在 views.py 文件中添加以下代码:
```python
from rest_framework import generics, permissions
from .models import Post
from .serializers import PostSerializer
class PostCreateView(generics.CreateAPIView):
queryset = Post.objects.all()
serializer_class = PostSerializer
permission_classes = (permissions.IsAuthenticated,)
def perform_create(self, serializer):
serializer.save(author=self.request.user)
class PostListView(generics.ListAPIView):
queryset = Post.objects.all()
serializer_class = PostSerializer
class PostDetailView(generics.RetrieveUpdateDestroyAPIView):
queryset = Post.objects.all()
serializer_class = PostSerializer
permission_classes = (permissions.IsAuthenticated,)
def perform_update(self, serializer):
serializer.save(author=self.request.user)
def perform_destroy(self, instance):
if instance.author == self.request.user:
instance.delete()
else:
raise PermissionDenied('You are not allowed to delete this post.')
```
在上述代码中,我们创建了 PostCreateView、PostListView 和 PostDetailView 三个视图。PostCreateView 和 PostDetailView 实现了创建、更新和删除 Post 对象,PostListView 实现了获取 Post 列表。
在 PostCreateView 和 PostDetailView 中,我们设置了 permission_classes,表示只有登录用户才能访问这些视图。在 perform_create 和 perform_update 方法中,我们为 Post 对象设置了作者。
在 PostDetailView 中,我们还重写了 perform_destroy 方法来检查删除 Post 对象的权限。如果当前用户不是该 Post 对象的作者,则会引发 PermissionDenied 异常。
最后,在 urls.py 文件中添加以下路由:
```python
from django.urls import path
from .views import UserCreateView, ObtainTokenView, PostCreateView, PostListView, PostDetailView
urlpatterns = [
path('users/', UserCreateView.as_view(), name='user_create'),
path('api-token-auth/', ObtainTokenView.as_view(), name='obtain_token'),
path('posts/', PostCreateView.as_view(), name='post_create'),
path('posts/list/', PostListView.as_view(), name='post_list'),
path('posts/<int:pk>/', PostDetailView.as_view(), name='post_detail'),
]
```
现在,你可以通过访问 /posts/ 来创建新的 Post 对象,并使用 /posts/list/ 和 /posts/<int:pk>/ 来获取和修改 Post 对象了。注意,只有登录用户才能访问这些视图。
阅读全文