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. EFCore 调试远程SqlServer数据库提示信号灯超时时间已到

    背景 最近在使用EFCore去连接阿里云上面的数据库进行开发的时候,当自己在Debug模式下总是提示下面的报错信息,然后找了好久都没有解决,报错信息如下: an exception has been ...

  2. 关于tomcat9的startup.bat闪退问题&乱码

    1.打开apache-tomcat-9.0.22的bin目录  选择图中文件  记事本打开 2.更改文件 setclasspath.bat .0_172\jre 3.保存  startup ----- ...

  3. MATLAB：一个K×M的矩阵，第一列是1，其它都是0，从最后一行开始，每循环一次，最后一行的1往右边移一位，移动到末尾后溢出，重新回到最左边，同时上一行的1往右边移一位

    问题:一个K×M的矩阵,第一列是1,其它都是0,从最后一行开始,每循环一次,最后一行的1往右边移一位,移动到末尾后溢出,重新回到最左边,同时上一行的1往右边移一位.上一行溢出时,上上一行的1移动一位, ...

  4. 剑指offer50：数组中重复的数字

    1 题目描述 在一个长度为n的数组里的所有数字都在0到n-1的范围内. 数组中某些数字是重复的,但不知道有几个数字是重复的.也不知道每个数字重复几次.请找出数组中任意一个重复的数字. 例如,如果输入长 ...

  5. python 之 并发编程（线程Event、协程）

    9.14 线程Event connect线程执行到event.wait()时开始等待,直到check线程执行event.set()后立即继续线程connect from threading impor ...

  6. Mysql之rpm安装5.7版本遇见的问题

    前言:环境是centos7.5的系统,用rpm方式安装mysql5.7 1.由于是centos7.5 所以需要将默认的mariadb给卸载 rpm -qa | grep mariadb 查看下是否有m ...

  7. 利用Python进行数据分析 第6章 数据加载、存储与文件格式（2）

    6.2 二进制数据格式 实现数据的高效二进制格式存储最简单的办法之一,是使用Python内置的pickle序列化. pandas对象都有一个用于将数据以pickle格式保存到磁盘上的to_pickle ...

  8. 史上最全最新java面试题合集二（附答案）

    下面小编整理了本套java面试题全集,分享给大家,希望对大家的java学习和就业面试有所帮助. 51.类ExampleA继承Exception,类ExampleB继承ExampleA. 有如下代码片断 ...

  9. Kettle部署笔记

    1.启动脚本(启动job) /u02/www/data-integration/kitchen.sh -file:/u02/www/data-integration/job.kjb -logfile= ...

  10. Powershell学习笔记：(一）、初识Powershell

    什么是Powershell? MSDN上的说明是:PowerShell 是构建于 .NET 上基于任务的命令行 shell 和脚本语言. PowerShell 可帮助系统管理员和高级用户快速自动执行用 ...