摘要:测试这是一个测试链接。注意编写注释是一个好的习惯。包括各个字段的验证标记,例如。字段标记也能够控制在某些环境中如何显示,例如呈现为之前的标记相当于中的。类似于有和类,也包含和两个类。
Serialization——序列化
官网地址
前言本教程将会介绍创建一个简单webAPI。在整个学习的过程中,将会逐一介绍到REST framework的各种组件,让你全面的了解所有东西是如果组合在一起的。
这个教程将会相当的详细,所以在开始之前,你应该去来点饼干,再喝上一些你喜欢的饮料。如果你只是想快速概览,你应该查看Quickstart.
注意:本教程的代码可以在GitHub的 tomchristie/rest-framework-tutorial中找到。测试,这是一个测试链接。
使用 virtualenv创建一个虚拟环境.
virtualenv env source env/bin/activate
然后我们在我们创建的虚拟环境中安装需要的包。
pip install django pip install djangorestframework pip install pygments #使用它来代码高亮
注意:使用 deactivate来随时退出虚拟环境。更多的信息请查看Virtualenv documentation
准备我们这边开始编写代码了。先来创建一个项目吧~
cd ~ django-admin.py startproject tutorial cd tutorial
接下来,我们创建一个app。
python manage.py startapp snippets
我们需要添加 snippets 和 rest_framework 到 INSTALLED_APPS,在 tutorial/settings.py文件中:
INSTALLED_APPS = { ... "rest_framework", "snippets.apps.SnippetsConfig", }
注意:如果你使用的django<1.9,你需要替换 snippets.apps.SnippetsConfig为snippets。
我们可以继续上路了。
在本教程中,我们将创建一个简单的model,这个model将用于储存代码片段。
编辑 snippets/models.py文件。
注意:编写注释是一个好的习惯。
from django.db import models from pygments.lexers import get_all_lexers from pygments.styles import get_all_styles LEXERS = [item for item in get_all_lexers() if item[1]] LANGUAGE_CHOICES = sorted([(item[1][0], item[0]) for item in LEXERS]) STYLE_CHOICES = sorted((item, item) for item in get_all_styles()) class Snippet(models.Model): created = models.DateTimeField(auto_now_add=True) title = models.CharField(max_length=100,blank=True,defalut="") code = models.TextField() linenos = models.BooleanField(default=False) language = models.CharField(choices=LANGUAGE_CHOICES,default="python",max_length=100) style = models.CharField(choices=STYLE_CHOICES,default="friendly",max_length=100) class Meta: ordering = ("created")
执行命令,创建数据表:
python manage.py makemigrations snippets python manage.py migrate创建Serializer
首先,我们需要给我们的web API 提供一种序列化和反序列化的呈现方式,如json。
我们可以申明一个和django的forms差不多的serializers。创建一个Serializers.py文件。
from rest_framework import serializers from snippets.models import Snippet, LANGUAGE_CHOICES, STYLE_CHOICES class SnippetSerializer(serializers.Serializer): id = serializers.IntegerField(read_only=True) title = serializers.CharField(required=False,allow_blank=True,max_length=100) code = serializers.CharField(style={"base_template":"textarea.html"}) linenos = serializers.BooleanField(required=False) language = serializers.ChoiceField(choices=LANGUAGE_CHOICES,default="python") style = serializers.ChoiceField(choices=STYLE_CHOICES,default="friendly") def create(self,validated_data): return Snippet.objects.create(**validated_data) def update(self,instance,validated_data): instance.title = validated_data.get("title", instance.title) instance.code = validated_data.get("code", instance.code) instance.linenos = validated_data.get("linenos", instance.linenos) instance.language = validated_data.get("language", instance.language) instance.style = validated_data.get("style", instance.style) instance.save() return instance
serializer的第一步是定义需要 序列化/反序列化 的字段。create()和update()方法定义当serializer.save()时,如果创建和更新。
serializer类非常类似于Django的Form类。包括各个字段的验证标记,例如 required,max_length,default。
字段标记也能够控制serializer在某些环境中如何显示,例如呈现为HTML.
之前的{"base_template": "textarea.html"}标记相当于django Form中的widget=widgets.Textarea`。
其实我们使用ModelSerializer类更能够节省我们的时间,但现在,我们还是显示的定义我们的字段。
开始工作在我们更进一步学习之前,我们将通过django shell来熟悉serializer。
python manage.py shell
我们需要导入我们需要的东西,然后创建两个snippet。
from snippets.models import Snippet from snippets.serializers import SnippetSerializer from rest_framework.renderers import JSONRenderer from rest_framework.parsers import JSONParser snippet = Snippet(code="foo="bar" ") snippet.save() snippet = Snippet(code="print "hello, world" ") snippet.save()
我们来看看我们创建的其中一个实例:
serializer = SnippetSerializer(snippet) serializer.data # {"id": 2, "title": u"", "code": u"print "hello, world" ", "linenos": False, "language": u"python", "style": u"friendly"}
在这里,我们翻译这个model实例为python原生的数据类型,为了完成序列化,我们将数据呈现为JSON。
content = JSONRenderer().render(serializer.data) content # "{"id": 2, "title": "", "code": "print "hello, world" ", "linenos": false, "language": "python", "style": "friendly"}"
反序列化类似。首先,我们解析一个流为Python原生数据类型。
from django.utils.six import BytesIO data = JSONParser().parse(stream)
然后我们还原原生数据类型到一个完全填充的对象实例中。
serializer = SnippetSerializer(data=data) serializer.is_valid() # True serializer.validated_data # OrderedDict([("title", ""), ("code", "print "hello, world" "), ("linenos", False), ("language", "python"), ("style", "friendly")]) serializer.save() #
注意:这类似于forms.当我们编写views使用serializer时,这会看起来更相似。
serializer = SnippetSerializer(Snippet.objects.all(), many=True) serializer.data # [OrderedDict([("id", 1), ("title", u""), ("code", u"foo = "bar" "), ("linenos", False), ("language", "python"), ("style", "friendly")]), OrderedDict([("id", 2), ("title", u""), ("code", u"print "hello, world" "), ("linenos", False), ("language", "python"), ("style", "friendly")]), OrderedDict([("id", 3), ("title", u""), ("code", u"print "hello, world""), ("linenos", False), ("language", "python"), ("style", "friendly")])]使用ModelSerializers
我们的SnippetSerializer类复制了很多snippet中的东西。我们希望我们的代码能够保持干净整洁。
类似于django有Form和ModelForm类,REST framework也包含Serializer和ModelSerializer两个类。
让我们来使用ModelSerializer来重构我们的serializer类。打开snippets/serializers.py,替换SinppetSerializer类:
class SnippetSerializer(serializers.ModelSerizer): class Meta: model = Snippet fields = ("id","title","code","linenos","language","style")
serializer拥有一个很好的属性,你能够通过打印查看一个serializer实例的所有字段。打开django shell(python manage.py shell):
from snippets.serializers import SnippetSerializer serializer = SnippetSerializer() print(repr(serializer)) # SnippetSerializer(): # id = IntegerField(label="ID", read_only=True) # title = CharField(allow_blank=True, max_length=100, required=False) # code = CharField(style={"base_template": "textarea.html"}) # linenos = BooleanField(required=False) # language = ChoiceField(choices=[("Clipper", "FoxPro"), ("Cucumber", "Gherkin"), ("RobotFramework", "RobotFramework"), ("abap", "ABAP"), ("ada", "Ada")... # style = ChoiceField(choices=[("autumn", "autumn"), ("borland", "borland"), ("bw", "bw"), ("colorful", "colorful")...
注意:ModelSerializer不会做任何如魔法般的事情,它只是更快捷的创建serializer
自动的确定字段的设置
简单的默认create()和update()方法
使用Serializer写一个常规的django views让我们使用我们新的serializer来写一些API视图吧。在这里,我们不会使用任何REST framework的其他特性,我们就写一个常规的 django views。
来编写 snippets/views.py文件吧:
from django.http import HttpResponse, JsonResponse from django.views.decorators.csrf import csrf_exempt from rest_framework.renderers import JSONRenderer from rest_framework.parsers import JSONParser from snippets.models import Snippet from snippets.serializers import SnippetSerializer
我们的API将会支持查看所有数据和创建一个新的snippet
@csrf_exempt def snippet_list(request): """ 显示所有的代码片段,或者创建一个新的片段 """ if request.method == "GET": snippets = Snippet.objects.all() serializer = SnippetSerializer(snippets, many=True) return JsonResponse(serializer.data, safe=False) elif request.method == "POST": data = JSONParser().parse(request) serializer = SnippetSerializer(data=data) if serializer.is_valid(): serializer.save() return JsonResponse(serializer.data, status=201) return JsonResponse(serializer.errors, status=400)
注意:因为我们希望post能够不通过CSRF token的验证,所以我们使用了 csrf_exempt。事实上,这不会是你经常做的事情,并且REST framework views会更加明智的做这个事情。但是现在,他可以使用。
我们还需要这个视图能够检索,更新和删除。
@csrf_exempt def snippet_detail(request, pk): """ Retrieve, update or delete a code snippet. """ try: snippet = Snippet.objects.get(pk=pk) except Snippet.DoesNotExist: return HttpResponse(status=404) if request.method == "GET": serializer = SnippetSerializer(snippet) return JsonResponse(serializer.data) elif request.method == "PUT": data = JSONParser().parse(request) serializer = SnippetSerializer(snippet, data=data) if serializer.is_valid(): serializer.save() return JsonResponse(serializer.data) return JsonResponse(serializer.errors, status=400) elif request.method == "DELETE": snippet.delete() return HttpResponse(status=204)
最后,我们需要创建url,在snippets/urls.py文件中
from django.conf.urls import url from snippets import views urlpatterns = [ url(r"^snippets/$", views.snippet_list), url(r"^snippets/(?P[0-9]+)/$", views.snippet_detail), ]
我们还需要在跟urls.py(tutorial/urls.py)上引入我们的urls.py
from django.conf.urls import url, include urlpatterns = [ url(r"^", include("snippets.urls")), ]
注意:我们的视图有某些问题是还没有做妥善的处理,比如发送的json格式不正确,或是调用视图没有的方法,那么我们就会返回一个500“服务器错误”的消息。
文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。
转载请注明本文地址:https://www.ucloud.cn/yun/40815.html
摘要:测试这是一个测试链接。注意编写注释是一个好的习惯。包括各个字段的验证标记,例如。字段标记也能够控制在某些环境中如何显示,例如呈现为之前的标记相当于中的。类似于有和类,也包含和两个类。 Serialization——序列化 官网地址 前言 本教程将会介绍创建一个简单webAPI。在整个学习的过程中,将会逐一介绍到REST framework的各种组件,让你全面的了解所有东西是如果组合在一...
摘要:测试这是一个测试链接。注意编写注释是一个好的习惯。包括各个字段的验证标记,例如。字段标记也能够控制在某些环境中如何显示,例如呈现为之前的标记相当于中的。类似于有和类,也包含和两个类。 Serialization——序列化 官网地址 前言 本教程将会介绍创建一个简单webAPI。在整个学习的过程中,将会逐一介绍到REST framework的各种组件,让你全面的了解所有东西是如果组合在一...
摘要:本文主要是用来记录自己学习的过程。其中可能会有很多自己的错误理解。这里主要会用到的知识有百度百科阮一峰理解架构其余请自行百度。所有的全局设置都放在的字典中。使用标准的权限,未认证的用户只读权限不要忘记将添加到你的中。 本文主要是用来记录自己学习django-rest-framework的过程。其中可能会有很多自己的错误理解。 这里主要会用到的知识有 1. [django](https:...
摘要:本文主要是用来记录自己学习的过程。其中可能会有很多自己的错误理解。这里主要会用到的知识有百度百科阮一峰理解架构其余请自行百度。所有的全局设置都放在的字典中。使用标准的权限,未认证的用户只读权限不要忘记将添加到你的中。 本文主要是用来记录自己学习django-rest-framework的过程。其中可能会有很多自己的错误理解。 这里主要会用到的知识有 1. [django](https:...
摘要:我们将会创建一个简单的,来让管理员能够查看和编辑和。我们将会在接下来的例子中使用这个账户。创建一个新的模块叫。但是是一个好的设计。最后,我们使用来导入默认的登录登出这是可选的。我们想启用分页和只有用户能够调用。 Quickstart 我们将会创建一个简单的API,来让管理员能够查看和编辑Users和Groups。 项目开始 创建一个新的项目叫 tutorial,然后创建一个app叫qu...
阅读 2781·2021-09-26 10:18
阅读 5046·2021-09-22 15:02
阅读 2734·2019-08-30 15:53
阅读 1809·2019-08-29 18:41
阅读 2661·2019-08-27 10:58
阅读 2589·2019-08-26 13:49
阅读 2714·2019-08-26 12:17
阅读 875·2019-08-26 11:49