教程4：认证和权限

目前我们的API对谁可以编辑或删除代码片段没有任何限制。我们希望有一些更高级的行为，以确保：

• 代码片段始终与创建者相关联。
• 只有经过身份验证的用户才可以创建片段。
• 只有代码段的创建者可能会更新或删除它。
• 未经身份验证的请求应具有完全只读访问权限。

将信息添加到我们的模型

我们将对Snippet模型类进行一些更改。首先，我们添加几个字段。其中一个字段将用于表示创建代码段的用户。其他字段将用于存储代码的突出显示的HTML表示形式。

将以下两个字段添加到Snippet模型中models.py。

owner = models.ForeignKey('auth.User', related_name='snippets', on_delete=models.CASCADE)
highlighted = models.TextField()

我们还需要确保保存模型时，使用pygments代码高亮库来填充突出显示的字段。

我们需要一些额外的导入：

from pygments.lexers import get_lexer_by_name
from pygments.formatters.html import HtmlFormatter
from pygments import highlight

现在我们可以在.save()模型类中添加一个方法：

def save(self, *args, **kwargs):
    """
    Use the `pygments` library to create a highlighted HTML
    representation of the code snippet.
    """
    lexer = get_lexer_by_name(self.language)
    linenos = self.linenos and 'table' or False
    options = self.title and {'title': self.title} or {}
    formatter = HtmlFormatter(style=self.style, linenos=linenos,
                              full=True, **options)
    self.highlighted = highlight(self.code, lexer, formatter)
    super(Snippet, self).save(*args, **kwargs)

完成之后，我们需要更新我们的数据库表。通常我们会创建一个数据库迁移来完成这个任务，但是为了本教程的目的，我们只需删除数据库并重新启动即可。

rm -f db.sqlite3
rm -r snippets/migrations
python manage.py makemigrations snippets
python manage.py migrate

您可能还想创建几个不同的用户，以用于测试API。最快的方法就是使用createsuperuser命令。

python manage.py createsuperuser

为我们的用户模型添加端点

现在我们有一些用户可以使用，我们最好将这些用户的表示添加到我们的API中。创建一个新的序列化器很容易。在serializers.py添加：

from django.contrib.auth.models import User

class UserSerializer(serializers.ModelSerializer):
    snippets = serializers.PrimaryKeyRelatedField(many=True, queryset=Snippet.objects.all())

    class Meta:
        model = User
        fields = ('id', 'username', 'snippets')

因为在User模型上'snippets'是一个反向关系，所以在使用这个ModelSerializer类的时候默认不会包含它，所以我们需要为它添加一个显式的字段。

我们也会添加几行代码到views.py中。我们希望只使用只读视图为用户表示，所以我们将使用ListAPIView和RetrieveAPIView通用的基于类的意见。

from django.contrib.auth.models import User

class UserList(generics.ListAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer

class UserDetail(generics.RetrieveAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer

确保也要导入这个UserSerializer类

from snippets.serializers import UserSerializer

最后，我们需要将这些视图添加到API中，方法是从URL conf中引用它们。将以下内容添加到中的模式中urls.py。

url(r'^users/$', views.UserList.as_view()),
url(r'^users/(?P<pk>[0-9]+)/$', views.UserDetail.as_view()),

将片段与用户相关联

现在，如果我们创建了一个代码片段，那么就没有办法将创建片段的用户与代码片段实例关联起来。用户不是作为序列化表示的一部分发送的，而是作为传入请求的属性。

我们处理这个问题的方式是通过覆盖.perform_create()片段视图上的方法，这允许我们修改实例保存的管理方式，并处理传入请求或请求URL中隐含的任何信息。

在SnippetList视图类中，添加以下方法：

def perform_create(self, serializer):
    serializer.save(owner=self.request.user)

create()我们的序列化程序的方法现在将被传递一个额外的'owner'字段，以及来自请求的验证数据。

更新我们的序列化器

现在，片段与创建它们的用户相关联，让我们更新SnippetSerializer以反映这一点。将以下字段添加到序列化程序定义中serializers.py：

owner = serializers.ReadOnlyField(source='owner.username')

注意：确保你也添加'owner',到内部Meta类的字段列表中。

这个字段正在做一些有趣的事情。source参数控制用于填充的字段，并且可以在对串行化实例的任何属性点。它也可以采用上面显示的虚线符号，在这种情况下，它将以与Django的模板语言类似的方式遍历给定的属性。

我们添加的字段是无类型的ReadOnlyField类，与其他类型的字段相比，例如CharField，BooleanField等等... untyped ReadOnlyField总是只读的，并且将被用于序列化的表示，但不会被用于更新模型当它们被反序列化时。我们也可以CharField(read_only=True)在这里使用。

将所需的权限添加到视图

现在，代码片段与用户相关联，我们要确保只有经过身份验证的用户才能创建，更新和删除代码片段。

REST框架包含许多权限类，我们可以使用这些权限类来限制可以访问给定视图的人员。在这种情况下，我们正在寻找的是IsAuthenticatedOrReadOnly确保通过身份验证的请求获得读写访问权限，未经身份验证的请求获得只读访问权限。

首先在视图模块中添加以下导入

from rest_framework import permissions

接着，下面的属性添加到都在SnippetList和SnippetDetail视图类。

permission_classes = (permissions.IsAuthenticatedOrReadOnly,)

添加登录到Browsable API

如果您现在打开浏览器并导航到可浏览的API，则会发现您不再能够创建新的代码片段。为了做到这一点，我们需要能够以用户身份登录。

我们可以通过编辑我们的项目级urls.py文件中的URLconf来添加可浏览API的登录视图。

在文件顶部添加以下导入：

from django.conf.urls import include

然后，在文件末尾添加一个模式，以包含可浏览API的登录和注销视图。

urlpatterns += [
    url(r'^api-auth/', include('rest_framework.urls')),
]

r'^api-auth/'模式的一部分实际上可以是任何您想要使用的URL。

现在，如果您再次打开浏览器并刷新页面，则会在页面右上方看到一个“登录”链接。如果您以前创建的用户之一登录，则可以再次创建代码片段。

一旦创建了一些代码片段，请导航到“/ users /”端点，并注意到代表性包括每个用户的“代码段”字段中与每个用户关联的代码段ID列表。

对象级权限

实际上，我们希望所有人都可以看到所有代码片段，但也要确保只有创建代码段的用户才能更新或删除它。

要做到这一点，我们将需要创建一个自定义权限。

在snippets应用程序中，创建一个新文件， permissions.py

from rest_framework import permissions

class IsOwnerOrReadOnly(permissions.BasePermission):
    """
    Custom permission to only allow owners of an object to edit it.
    """

    def has_object_permission(self, request, view, obj):
        # Read permissions are allowed to any request,
        # so we'll always allow GET, HEAD or OPTIONS requests.
        if request.method in permissions.SAFE_METHODS:
            return True

        # Write permissions are only allowed to the owner of the snippet.
        return obj.owner == request.user

现在，我们可以通过编辑视图类的permission_classes属性，将自定义权限添加到代码片段实例端点SnippetDetail：

permission_classes = (permissions.IsAuthenticatedOrReadOnly,
                      IsOwnerOrReadOnly,)

确保也要导入这个IsOwnerOrReadOnly类。

from snippets.permissions import IsOwnerOrReadOnly

现在，如果您再次打开浏览器，则如果您以创建代码段的相同用户身份登录，则会发现“DELETE”和“PUT”操作仅出现在代码片段实例端点上。

使用API​​进行身份验证

因为我们现在在API上拥有一组权限，所以如果我们要编辑任何代码片段，我们需要验证我们的请求。我们还没有设置任何认证类，所以默认是当前应用的，这是SessionAuthentication和BasicAuthentication。

当我们通过Web浏览器与API进行交互时，我们可以登录，然后浏览器会话将为请求提供所需的身份验证。

如果我们正在以编程方式与API进行交互，则需要在每个请求上明确提供身份验证凭据。

如果我们尝试创建一个没有验证的片段，我们会得到一个错误：

http POST http://127.0.0.1:8000/snippets/ code="print 123"

{
    "detail": "Authentication credentials were not provided."
}

我们可以通过包含我们之前创建的用户的用户名和密码来提出成功的请求。

http -a admin:password123 POST http://127.0.0.1:8000/snippets/ code="print 789"

{
    "id": 1,
    "owner": "admin",
    "title": "foo",
    "code": "print 789",
    "linenos": false,
    "language": "python",
    "style": "friendly"
}

概要

我们现在已经在我们的Web API上获得了相当细致的权限集合，以及系统用户和他们创建的代码片段的端点。

在本教程的第5部分中，我们将研究如何通过为突出显示的片段创建HTML端点来将所有内容绑定在一起，并通过使用系统内关系的超链接来改进API的凝聚力。