5-关系和超链接API-Django REST框架

教程5：关系和超链接API

目前，API中的关系是使用主键表示的。在本教程的这一部分中，我们将通过为关系使用超链接来改进API的内聚力和可发现性。

为API的根创建端点

现在我们有“代码段”和“用户”的端点，但是我们没有一个API的入口点。要创建一个视图，我们将使用一个基于常规函数的视图，@api_view我们之前介绍的装饰师。在你的snippets/views.py加：

from rest_framework.decorators import api_view
from rest_framework.response import Response
from rest_framework.reverse import reverse

@api_view(['GET'])
def api_root(request, format=None):
    return Response({
        'users': reverse('user-list', request=request, format=format),
        'snippets': reverse('snippet-list', request=request, format=format)
    })

这里应该注意两件事。首先，我们使用REST框架的function reverse() { [native code] }函数以返回完全限定的URL；其次，URL模式由我们稍后将在snippets/urls.py.

为突出显示的片段创建端点

我们的pastebinAPI仍然缺少的另一个显而易见的东西是突出显示端点的代码。

与所有其他API端点不同，我们不想使用JSON，而只是提供一个HTML表示。REST框架提供了两种HTML呈现器，一种用于处理使用模板呈现的HTML，另一种用于处理预先呈现的HTML。第二个呈现器是我们想要用于这个端点的那个。

在创建代码突出显示视图时，我们需要考虑的另一件事是，我们无法使用现有的具体泛型视图。我们不是返回对象实例，而是返回对象实例的属性。

我们将使用基类来表示实例，而不是使用具体的泛型视图，并创建自己的.get()方法。在你的snippets/views.py加：

from rest_framework import renderers
from rest_framework.response import Response

class SnippetHighlight(generics.GenericAPIView):
    queryset = Snippet.objects.all()
    renderer_classes = [renderers.StaticHTMLRenderer]

    def get(self, request, *args, **kwargs):
        snippet = self.get_object()
        return Response(snippet.highlighted)

与往常一样，我们需要将我们创建的新视图添加到URLconf中。我们将为我们的新API根添加一个url模式snippets/urls.py:

path('', views.api_root),

然后为片段高光添加一个url模式：

path('snippets/<int:pk>/highlight/', views.SnippetHighlight.as_view()),

超链接我们的API

处理实体之间的关系是WebAPI设计中更具挑战性的方面之一。我们可以选择多种不同的方式来代表一种关系：

• 使用主键。
• 使用实体之间的超链接。
• 在相关实体上使用唯一的识别段塞字段。
• 使用相关实体的默认字符串表示形式。
• 嵌套父表示中的相关实体。
• 其他一些自定义表示法。

REST框架支持所有这些样式，可以跨正向或反向关系应用它们，也可以跨自定义管理器(如泛型外键)应用它们。

在这种情况下，我们希望在实体之间使用超链接样式。为此，我们将修改序列化程序以扩展HyperlinkedModelSerializer而不是现有的ModelSerializer.

这个HyperlinkedModelSerializer有以下不同之处：ModelSerializer:

• 它不包括id默认情况下为字段。
• 它包括一个url字段、使用HyperlinkedIdentityField.
• 关系使用HyperlinkedRelatedField，而不是PrimaryKeyRelatedField.

我们可以轻松地重写现有的序列化程序以使用超链接。在你的snippets/serializers.py加：

class SnippetSerializer(serializers.HyperlinkedModelSerializer):
    owner = serializers.ReadOnlyField(source='owner.username')
    highlight = serializers.HyperlinkedIdentityField(view_name='snippet-highlight', format='html')

    class Meta:
        model = Snippet
        fields = ['url', 'id', 'highlight', 'owner',
                  'title', 'code', 'linenos', 'language', 'style']

class UserSerializer(serializers.HyperlinkedModelSerializer):
    snippets = serializers.HyperlinkedRelatedField(many=True, view_name='snippet-detail', read_only=True)

    class Meta:
        model = User
        fields = ['url', 'id', 'username', 'snippets']

注意，我们还添加了一个新的'highlight'技术领域。此字段的类型与url字段，但它指向'snippet-highlight'URL模式，而不是'snippet-detail'URL模式

因为我们包含了格式后缀URL，例如'.json'，我们还需要在highlight字段，它返回的任何格式后缀的超链接都应该使用'.html'后缀。

确保我们的URL模式被命名为

如果我们要有一个超链接API，我们需要确保命名我们的URL模式。让我们来看看我们需要命名哪些URL模式。

• 我们的api的根引用'user-list'和'snippet-list'.
• 我们的片段序列化程序包括一个引用'snippet-highlight'.
• 我们的用户序列化程序包括一个引用'snippet-detail'.
• 我们的片段和用户序列化程序包括'url'默认情况下将引用的字段。'{model_name}-detail'，在这种情况下'snippet-detail'和'user-detail'.

在把所有这些名字加到我们的URLCONF之后，我们的期末考试snippets/urls.py文件应该如下所示：

from django.urls import path
from rest_framework.urlpatterns import format_suffix_patterns
from snippets import views

# API endpoints
urlpatterns = format_suffix_patterns([
    path('', views.api_root),
    path('snippets/',
        views.SnippetList.as_view(),
        name='snippet-list'),
    path('snippets/<int:pk>/',
        views.SnippetDetail.as_view(),
        name='snippet-detail'),
    path('snippets/<int:pk>/highlight/',
        views.SnippetHighlight.as_view(),
        name='snippet-highlight'),
    path('users/',
        views.UserList.as_view(),
        name='user-list'),
    path('users/<int:pk>/',
        views.UserDetail.as_view(),
        name='user-detail')
])

添加分页

用户和代码片段的列表视图最终可能返回相当多的实例，因此我们确实希望确保对结果进行分页，并允许API客户端逐步遍历每个单独的页面。

我们可以通过修改tutorial/settings.py稍微归档。添加以下设置：

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 10
}

注意，REST框架中的设置都被命名为单个字典设置，命名为REST_FRAMEWORK，这有助于将它们与其他项目设置很好地分离开来。

如果需要的话，我们也可以定制分页样式，但在这种情况下，我们只需使用默认的。

浏览API

如果我们打开一个浏览器并导航到可浏览的API，您会发现现在您可以通过以下链接绕过API。

您还可以看到片段实例上的“突出显示”链接，这些链接将带您进入突出显示的代码HTML表示。

在……里面第6部分在本教程中，我们将研究如何使用ViewSets和路由器来减少构建API所需的代码量。