Django REST框架--关系和超连接api

目前咱们的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表示。

接下来咱们将介绍如何使用ViewSets和路由器来减小构建API所需的代码量。