05_Tutorial 5: Relationships & Hyperlinked APIs 关系和超链接
1、关系和超链接
0、文档
https://www.django-rest-framework.org/tutorial/5-relationships-and-hyperlinked-apis/
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 关系和超链接的更多相关文章
- Tutorial 5: Relationships & Hyperlinked APIs
转载自:http://www.django-rest-framework.org/tutorial/5-relationships-and-hyperlinked-apis/ Tutorial 5: ...
- Django REST framework 第五章 Relationships & Hyperlinked APIs
到目前为止,API内部的关系是使用主键来代表的.在这篇教程中,我们将提高API的凝聚力和可发现性,通过在相互关系上使用超链接. Creating an endpoint for the root of ...
- 5，基于关系和超链接的 API
Tutorial 5: Relationships & Hyperlinked APIs At the moment relationships within our API are repr ...
- django rest framwork教程之外键关系和超链接
此时,我们的API中的关系通过使用主键来表示.在本教程的这一部分中,我们将通过使用超链接来改善关系的内聚性和可发现性 为我们的API的根创建一个端点 现在我们有"snippets" ...
- EntityFramework 学习 一 Entity Relationships 实体的关系
下面,我们学习Entity Framework怎么管理实体间的关系 Entity Framework支持三种关系:一对一的关系.一对多的关系.多对多的关系 前面我们创建SchoolDB的实体数据模型, ...
- django-rest-framework快速入门
前言:第一次接触django-rest-framework是在实习的时候.当时也不懂,看到视图用类方法写的感觉很牛逼的样子.因为官网是英文的,这对我的学习还是有一点的阻力的,所以当时也没怎么学.真是太 ...
- django rest framework 详解
Django REST framework 是用于构建Web API 的强大而灵活的工具包. 我们可能想使用REST框架的一些原因: Web浏览API对于开发人员来说是一个巨大的可用性. 认证策略包括 ...
- 1.【使用EF Code-First方式和Fluent API来探讨EF中的关系】
原文链接:http://www.c-sharpcorner.com/UploadFile/3d39b4/relationship-in-entity-framework-using-code-firs ...
- Python基于共现提取《釜山行》人物关系
Python基于共现提取<釜山行>人物关系 一.课程介绍 1. 内容简介 <釜山行>是一部丧尸灾难片,其人物少.关系简单,非常适合我们学习文本处理.这个项目将介绍共现在关系中的 ...
随机推荐
- 011 Android AutoCompleteTextView(自动完成文本框)的基本使用
1.XML布局 android:completionThreshold="1":这里我们设置了输入一个字就显示提示 (1)主界面布局 <?xml version=" ...
- myeclipse 相关问题
[如何设置 Tab 键为四个空格] https://blog.csdn.net/QQ826688096/article/details/90543252
- [转帖]各种命令,以及FAQ..持续更新.....
各种命令,以及FAQ..持续更新..... https://www.cnblogs.com/jicki/p/5548668.html Linux 篇: CentOs 7 修改主机名 hostnamec ...
- QT 创建一个线程播放监控视频
1.创建一个线程类(PlayVideoThread): PlayVideoThread.h头文件 #pragma once #include <QObject> #include &quo ...
- 【MIT 6.824 】分布式系统 课程笔记（二）Lecture 03 ： GFS
Lecture 03 : GFS 一.一致性 1, 弱一致性 可能会读到旧数据 2, 强一致性 读到的数据都是最新的 3, 一致性比较 强一致性对于app的写方便, 但是性能差 弱一致性有良好的性能, ...
- leetcode 2019.10.29 首次破百
刷题首次破百,记录一下自己成长的历程. 仍在路上,会慢慢变强的~
- 第五章 模块之 struct、dis、正则表达式、异常处理
5.15 struct模块 pack 能够把所有的数字都固定的转换成4字节 5.16 dis dis.dis 查看计算机指令 5.16 正则表达式 基础 正则表达式概念: 是一种规则(元字符,量词) ...
- Python后台执行不启用缓存
1.运行时加-u参数,如 # python3 -u test.py >> test.log & 用man查看python的-u参数,说明如下: Force stdin, stdou ...
- Vue Prop属性（父to子）
通过Prop向子组件传递数据 第一步父组件中 <template> <div id="app"> <Users :users="users& ...
- Express配置ssl证书，为网站开启https
本文不对express多做介绍,下面直奔主题: 一.下载证书(以腾讯云为例): 解压下载的压缩包,找到Nginx文件夹,里面有两个以crt和key结尾的文件,在你的项目根目录新建名为https的空文件 ...