[Django REST FrameWork][5]:关系和超链接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[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[0-9]+)/$',

        views.SnippetDetail.as_view(),

        name='snippet-detail'),

    url(r'^snippets/(?P[0-9]+)/highlight/$',

        views.SnippetHighlight.as_view(),

        name='snippet-highlight'),

    url(r'^users/$',

        views.UserList.as_view(),

        name='user-list'),

    url(r'^users/(?P[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所需的代码量。s

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,064评论 5 466
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,606评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,011评论 0 328
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,550评论 1 269
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,465评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,919评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,428评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,075评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,208评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,185评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,191评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,914评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,482评论 3 302
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,585评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,825评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,194评论 2 344
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,703评论 2 339

推荐阅读更多精彩内容