ModelSerializer
教程来源杜塞-django-vue系列
博客链接 传送门
上一章我们借助 DRF 库,写了一个简单的序列化器:
# article/serializer.py
from rest_framework import serializers
class ArticleListSerializer(serializers.Serializer):
id = serializers.IntegerField(read_only=True)
title = serializers.CharField(allow_blank=True, max_length=100)
body = serializers.CharField(allow_blank=True)
created = serializers.DateTimeField()
updated = serializers.DateTimeField()
这个序列化器跟 Form
或者 Model
太像了,甚至感觉代码重复冗余,如果再简洁就更好了。 DRF 也考虑这一点,并提供了解决方案,也就是ModelSerializer
。
将序列化器修改为以下:
# article/serializers.py
from rest_framework import serializers
from article.models import Article
# 父类变为 ModelSerializer
class ArticleListSerializer(serializers.ModelSerializer):
class Meta:
model = Article
fields = [
'id',
'title',
'created',
]
ModelSerializer的功能与上一章的serializers基本一致,不同的是他额外功能,更像是升级版或者扩展版。
扩展地方:
- 自动推断需要序列化的字段及类型
- 提供对字段数据的验证器的默认实现
- 提供了i需改七需要用到的
.create()
、.update()
方法的默认实现
另外我们还可以在 fileds
列表挑选出需要的数据与字段,减少数据体积。
再次访问我们的项目,页面得到的数据就变成了以下:
[
{
"created": "2021-06-11T11:35:50Z",
"id": 1,
"title": "python"
},
{
"created": "2021-06-11T11:37:15Z",
"id": 2,
"title": "Java"
},
{
"created": "2021-06-11T11:37:34Z",
"id": 3,
"title": "test"
}
]
可以看到 Json 数据仅包含 fields
中规定的字段了。
APIView
除了对序列化器的支持外,DRF 还提供了对试图的扩展,以便试图更好的为接口服务。
将文章的试图修改为一下:
...
from rest_framework.decorators import api_view
from rest_framework.response import Response
from rest_framework import status
@api_view(['GET','POST'])
def article_list(request):
if request.method == 'GET':
articles = Article.objects.all()
serializer = ArticleListSerializer(articles,many=True)
return Response(serializer.data)
elif request.method == 'POST':
serializer = ArticleListSerializer(data=request.data)
if serializer.is_valid():
serializer.save()
return Response(serializer.data, status=status.HTTP_201_CREATED)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
主要变化:
@api_view
装饰器,是允许试图接收GET
,POST
请求,以提供405 Method Not Allowed
等默认实现,在不同请求方式下进行正确的相应。- 返回了
Response
,该对象由原生Django 响应体扩展而来,通俗来讲,他可以确定数据的正确性,然后带有状态码的返回数据。
浏览器访问文章列表接口:
说好的只返回Json数据,为毛出现的界面。
这就不得不提 Response
提供的协商能力了,通俗讲,就是它会根据我们访问请求形式的不同来返回不同的样式;浏览器请求资源时,
就返回可视化的HTML资源表示(暂且理解为方便测试用);其他形式请求时,又可以返回Json数据。这就为前期开发提供便利。
如何查看只有Json数据的请求呢,那我们就发送一个网络请求。
在命令行发送请求,推荐使用轻量级 httpie这个库,基于python。
pip安装可以选择全局安装,不限于虚拟环境。
(venv) E:\drf>http http://127.0.0.1:8000/api/article/
HTTP/1.1 200 OK
Allow: OPTIONS, POST, GET
Content-Length: 174
Content-Type: application/json
Date: Fri, 11 Jun 2021 14:32:42 GMT
Referrer-Policy: same-origin
Server: WSGIServer/0.2 CPython/3.9.4
Vary: Accept, Cookie
X-Content-Type-Options: nosniff
X-Frame-Options: DENY
[
{
"created": "2021-06-11T11:35:50Z",
"id": 1,
"title": "python"
},
{
"created": "2021-06-11T11:37:15Z",
"id": 2,
"title": "Java"
},
{
"created": "2021-06-11T11:37:34Z",
"id": 3,
"title": "test"
}
]
发送 POST
请求新建文章:
(venv) E:\drf>http POST http://127.0.0.1:8000/api/article/ title=c++ body=Hello
HTTP/1.1 201 Created
Allow: OPTIONS, POST, GET
Content-Length: 62
Content-Type: application/json
Date: Fri, 11 Jun 2021 14:34:28 GMT
Referrer-Policy: same-origin
Server: WSGIServer/0.2 CPython/3.9.4
Vary: Accept, Cookie
X-Content-Type-Options: nosniff
X-Frame-Options: DENY
{
"created": "2021-06-11T14:34:28.022152Z",
"id": 4,
"title": "c++"
}
我们不难发现,它会贴心的返回的创建状态,这里是创建成功。
至此,浏览文章列表,新建文章接口已经完成了。
注意事项
叫成为了简洁,使用轻量级的httpie库来测试发送web请求。
但是win命令行存在中文问题,符号不兼容,因此跟推荐Postman,可视化界面,方便操作,而且完全免费!!!
使用 Postman 时要注意,在 Json 中单双引号含义是不同的,不要混用。