1、关系和超链接

0、文档

https://www.django-rest-framework.org/tutorial/5-relationships-and-hyperlinked-apis/

https://q1mi.github.io/Django-REST-framework-documentation/tutorial/5-relationships-and-hyperlinked-apis_zh/

1、效果

2、name用法，配合reverse

第一，我们使用REST框架的reverse功能来返回完全限定的URL；

第二，URL模式是通过方便的名称来标识的，我们稍后将在snippets/urls.py中声明。

view

from rest_framework.reverse import reverse

urlpatterns = format_suffix_patterns([

    path('', views.api_root),       # 主index页面

    path('snippets/', views.SnippetList.as_view(), name='snippet-list'),        # name用法，配合reverse('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'),

])

model

@api_view(['GET'])

def api_root(request, format=None):     # 入口，首页

    return Response({

        'users': reverse('user-list', request=request, format=format),      # reverse 反转

        'snippets': reverse('snippet-list', request=request, format=format),

    })

3、 超链接序列化：HyperlinkedModelSerializer

处理好实体之间的关系：希望在实体之间使用超链接方式

view视图不变

class UserList(generics.ListAPIView):  # user/ get方式

    queryset = User.objects.all().order_by('id')

    serializer_class = UserSerializer

序列化：继承HyperModelSerilizer

class UserSerializer(serializers.HyperlinkedModelSerializer):   # 实体之间使用超链接方式

    # snippets = serializers.PrimaryKeyRelatedField(many=True, queryset=Snippet.objects.all())  # 添加一个显式字段 外键

    # 关联关系，alex的snippet的详情

    # many=True，多个字段，

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

    class Meta:

        model = User

        fields = ['url', 'id', 'username', 'snippets']

class SnippetSerializer(serializers.ModelSerializer):

    owner = serializers.ReadOnlyField(source='owner.username')        # source参数控制哪个属性用于填充字段

    # # 它包含一个url字段  该snippet的highlight

    # 单个字段，继承与HyperlinkedRelatedField

    highlight = serializers.HyperlinkedIdentityField(view_name='snippet-highlight', format='html')

    class Meta:

        model = Snippet

        fields = ['url', 'id', 'title', 'code', 'linenos', 'language', 'style', 'owner', 'highlight']

4、HyperlinkedModelSerialize与ModelSerializer区别

HyperlinkedModelSerializer与ModelSerializer有以下区别：

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

5、高亮代码

model层

class Snippet(models.Model):

    created = models.DateTimeField(auto_now_add=True)  # 创建时间

    title = models.CharField(max_length=100, blank=True, default='')

    code = models.TextField()

    linenos = models.BooleanField(default=False)

    # choices = [(1,'java'),(2,'python'),(3,''golang')]  # 下拉框选择，指代

    language = models.CharField(choices=LANGUAGE_CHOICES, default='python', max_length=100)

    style = models.CharField(choices=STYLE_CHOICES, default='friendly', max_length=100)

    # Tutorial 4: Authentication & Permissions

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

    # 设置related_name参数来覆盖原名称owner_id(ORM查询时)，实质，DB中还是owner_id

    highlighted = models.TextField()

    class Meta:

        ordering = ['created']

    # def save(self, force_insert=False, force_update=False, using=None, update_fields=None):

    def save(self, *args, **kwargs):

        """

        使用pygments库，创建一个高亮显示的HTML，表示代码段

        """

        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)  # 继承父类Model的save

6、HTML渲染器

一个HTML渲染器类，简单地返回预渲染的HTML
data = '<html><body>example</body></html>'
return Response(data)

view层

from rest_framework import renderers

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)    # 某个字段

05_Tutorial 5: Relationships & Hyperlinked APIs 关系和超链接的更多相关文章

  1. Tutorial 5: Relationships & Hyperlinked APIs

    转载自:http://www.django-rest-framework.org/tutorial/5-relationships-and-hyperlinked-apis/ Tutorial 5: ...

  2. Django REST framework 第五章 Relationships & Hyperlinked APIs

    到目前为止,API内部的关系是使用主键来代表的.在这篇教程中,我们将提高API的凝聚力和可发现性,通过在相互关系上使用超链接. Creating an endpoint for the root of ...

  3. 5，基于关系和超链接的 API

    Tutorial 5: Relationships & Hyperlinked APIs At the moment relationships within our API are repr ...

  4. django rest framwork教程之外键关系和超链接

    此时,我们的API中的关系通过使用主键来表示.在本教程的这一部分中,我们将通过使用超链接来改善关系的内聚性和可发现性 为我们的API的根创建一个端点 现在我们有"snippets" ...

  5. EntityFramework 学习 一 Entity Relationships 实体的关系

    下面,我们学习Entity Framework怎么管理实体间的关系 Entity Framework支持三种关系:一对一的关系.一对多的关系.多对多的关系 前面我们创建SchoolDB的实体数据模型, ...

  6. django-rest-framework快速入门

    前言:第一次接触django-rest-framework是在实习的时候.当时也不懂,看到视图用类方法写的感觉很牛逼的样子.因为官网是英文的,这对我的学习还是有一点的阻力的,所以当时也没怎么学.真是太 ...

  7. django rest framework 详解

    Django REST framework 是用于构建Web API 的强大而灵活的工具包. 我们可能想使用REST框架的一些原因: Web浏览API对于开发人员来说是一个巨大的可用性. 认证策略包括 ...

  8. 1.【使用EF Code-First方式和Fluent API来探讨EF中的关系】

    原文链接:http://www.c-sharpcorner.com/UploadFile/3d39b4/relationship-in-entity-framework-using-code-firs ...

  9. Python基于共现提取《釜山行》人物关系

    Python基于共现提取<釜山行>人物关系 一.课程介绍 1. 内容简介 <釜山行>是一部丧尸灾难片,其人物少.关系简单,非常适合我们学习文本处理.这个项目将介绍共现在关系中的 ...

随机推荐

  1. [WCF] - 使用 [DataMember] 标记的数据契约需要声明 Set 方法

    WCF 数据结构中返回的只读属性 TotalCount 也需要声明 Set 方法. [DataContract]public class BookShelfDataModel{    public B ...

  2. [VS] - 手工打开 WCF 客户端调试工具

    操作步骤 1. 在开始菜单中找到 Visual Studio 命令行工具 2. 输入命令 wcftestclient 即可打开 WCF 客户端测试工具 参考资料http://www.cnblogs.c ...

  3. 用 Python 把微信小程序的二维码转化成图片

    官方文档 import cString import requests from tornado.web import authenticated, RequestHandler URL = 'htt ...

  4. rabbitMQ 重试

    rabbitMQ 重试机制 spring.rabbitmq.listener.simple.retry.max-attempts=5 最大重试次数spring.rabbitmq.listener.si ...

  5. A Story of One Country (Hard) CodeForces - 1181E2 (分治)

    大意: 给定$n$个平面上互不相交的矩形. 若一个矩形区域只包含一个矩形或者它可以水平或垂直切成两块好的区域, 那么这个矩形区域是好的. 求判断整个平面区域是否是好的. 分治判断, 可以用链表实现删除 ...

  6. 使用Dockerfile构建镜像并push到私有仓库

    环境:OS X 10.10.5 maven 3.3.9 Docker version 1.12.2 docker-machine version 0.8.2 程序示例为http://www.cnblo ...

  7. lambda的一些用法

    lambda在函数中调用时可以不用传入形参,当需要时才传入参数,方便一些场合中的使用(当参数一直变化时,仍然需要调用函数,可以采用如下方式).如以下代码所示. import numpy as np d ...

  8. android studio 开发环境配置

    android studio 开发环境配置 参考: 第一次使用Android Studio时你应该知道的一切配置 https://www.cnblogs.com/qianguyihao/p/43909 ...

  9. VBA Exit Do语句

    当想要根据特定标准退出Do循环时,可使用Exit Do语句. 它可以同时用于Do...While和Do...Until直到循环. 当Exit Do被执行时,控制器在Do循环之后立即跳转到下一个语句. ...

  10. MVC-区域(Area)

    1.启用路由前的准备工作 1.Global.asax.cs中注册路由 public class MvcApplication : System.Web.HttpApplication { protec ...