目前我们的API中的关系通过使用主键来表示。在本教程的这一部分中，我们将改进API的内聚力和可发现性，而不是使用超链接来进行关系。
为我们的API的根创建一个端点
现在我们有'snippets'和'users'的端点，但是我们的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框架的reverse功能来返回完全限定的URL; 第二，URL模式是通过方便的名称来识别的，我们稍后会在此声明snippets/urls.py。
为突出显示的片段创建端点
我们的pastebin API中仍然缺少的另一个明显的事情是代码突出显示端点。
与所有其他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：
url(r'^/$', views.api_root),
然后为代码片段添加一个url模式：
url(r'^snippets/(?P<pk>[0-9]+)/highlight/$', views.SnippetHighlight.as_view()),
超链接我们的API
处理实体之间的关系是Web API设计中更具挑战性的方面之一。我们可以选择代表关系的一些不同的方式：
-
使用主键
-
在实体之间使用超链接。
-
在相关实体上使用唯一的标识字段。
-
使用相关实体的默认字符串表示形式。
-
将相关实体嵌套在父表示内。
-
一些其他自定义表示。
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.conf.urls import url, include
from rest_framework.urlpatterns import format_suffix_patterns
from snippets import views
# API endpoints
urlpatterns = format_suffix_patterns([
url(r'^$'>, views.api_root),
url(r'^snippets/$'>,
views.SnippetList.as_view(),
name='snippet-list'),
url(r'^snippets/(?P<pk>[0-9]+)/$'>,
views.SnippetDetail.as_view(),
name='snippet-detail'),
url(r'^snippets/(?P<pk>[0-9]+)/highlight/$'>,
views.SnippetHighlight.as_view(),
name='snippet-highlight'),
url(r'^users/$'>,
views.UserList.as_view(),
name='user-list'),
url(r'^users/(?P<pk>[0-9]+)/$'>,
views.UserDetail.as_view(),
name='user-detail')
])
# Login and logout views for the browsable API
urlpatterns += [
url(r'^api-auth/', include('rest_framework.urls',
namespace='rest_framework')),
]
添加分页
用户和代码段的列表视图可能会返回相当多的实例，因此我们希望确保分页结果，并允许API客户端逐步浏览每个单独的页面。
我们可以通过tutorial/settings.py稍微修改我们的文件来更改默认列表样式来使用分页。添加以下设置：
REST_FRAMEWORK = {
'PAGE_SIZE': 10
}
请注意，REST框架中的设置都命名为单个字典设置，名为“REST_FRAMEWORK”，这有助于保持与其他项目设置的良好分离。
我们也可以自定义分页风格，如果我们也需要，但在这种情况下，我们将坚持默认。
浏览API
如果我们打开浏览器并导航到可浏览的API，那么您将发现您现在可以通过以下链接了解API的方法。
您还可以在代码段实例上看到“突出显示”链接，这将使您转到突出显示的代码HTML表示。
在本教程的第6部分中，我们将介绍如何使用ViewSets和路由器来减少构建API所需的代码量。
网友评论