序列化

我们的项目名称叫 tutorial ,包含一个 app 名为 myApp。首先我们编辑 tutorial/settings.py 文件,在 INSTALLED_APPS 部分添加以下内容:

INSTALLED_APPS = (
    ...
    'rest_framework',
    'myApp',
)

编辑 myApp/models.py 文件:

from django.db import models

class Book(models.Model):
    title = models.CharField(null=True, blank=True, max_length=50)
    author = models.CharField(null=True, blank=True, max_length=50)
    amount = models.IntegerField()

    def __str__(self):
        return self.title




创建一个序列化类

要实现一个 Web API ,我们需要将代码片段实例 序列化反序列化 为诸如 json 之类的形式的方式。

该需求可以通过 序列化器(serializers)来实现,序列化器的使用与 Django forms 非常相似。

我们新建一个 myApp/serializers.py 文件,编写一个序列化器:

from rest_framework import serializers

class BookSerializer(serializers.Serializer):
    title = serializers.CharField(max_length=50)
    author = serializers.CharField(max_length=50)
    amount = serializers.IntegerField()

序列化器类与 Django Form 类非常相似,并在各种字段中包含类似的验证标志,例如 requiredmax_lengthdefault

我们实际上也可以通过使用 ModelSerializer 类来节省时间,就像我们后面会用到的那样。但是现在我们还继续使用我们明确定义的 serializer

现在在 shell 中看看序列化器的用法:

>>> from myApp.models import Book
>>> from myApp.serializers import BookSerializer

>>> book = Book.objects.get(id=1)
>>> bs = BookSerializer(book)  # 序列化 book 的一个实例

>>> bs.data  # 查看序列化的信息
{'author': 'author1', 'title': 'book1', 'amount': 1}

此时,我们将序列化对象转换为比特流(bytes):

>>> from rest_framework.renderers import JSONRenderer

>>> content = JSONRenderer().render(bs.data)
>>> content
b'{"title":"book1","author":"author1","amount":1}'

>>> type(content)
<class 'bytes'>

反序列化是类似的。首先我们将一个流(stream)解析为字典(dict):

>>> from django.utils.six import BytesIO
>>> from rest_framework.parsers import JSONParser

>>> stream = BytesIO(content)
>>> data = JSONParser().parse(stream)

>>> data
{'author': 'author1', 'title': 'book1', 'amount': 1}

>>> type(data)
<class 'dict'>

我们也可以序列化一个 查询集(querysets)而不仅仅是模型实例,我们只需要为 serializer 添加一个 many=True 语句:

>>> books = Book.objects.all()
>>> bs = BookSerializer(books, many=True)
>>> bs.data
[OrderedDict([('id', 1), ('title', 'book1'), ('author', 'author1'), ('amount', 1)]), 
OrderedDict([('id', 2), ('title', 'book2'), ('author', 'author2'), ('amount', 3)])]




使用 ModelSerializers

像 Django 的 FormModelForm 一样,REST framework 也包括 SerializerModelSerializer

使用 ModelSerializer 可以直接通过 Model 创建序列化器:

from rest_framework import serializers
from myApp.models import Book

class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = ('id', 'title', 'author', 'amount')




简单 API 实例

我们先自定义一个 JSONResponse 类:

from django.http import HttpResponse
from rest_framework.renderers import JSONRenderer

class JSONResponse(HttpResponse):
    """
    自定义一个 JSONResponse 继承自 HttpResponse
    让数据渲染成 json 后再返回 Response
    并把 Response 的 content_type 属性改为 application/json
    """
    def __init__(self, data, **kwargs):
        content = JSONRenderer().render(data)
        kwargs['content_type'] = 'application/json'
        super(JSONResponse, self).__init__(content, **kwargs)

然后在 views.py 中编写试图函数(完整版):

from django.shortcuts import render
from django.http import HttpResponse

from rest_framework.renderers import JSONRenderer
from rest_framework.parsers import JSONParser

from myapp.models import Book
from myapp.serializers import BookSerializer


class JSONResponse(HttpResponse):
    """
    自定义一个 JSONResponse 继承自 HttpResponse
    让数据渲染成 json 后再返回 Response
    并把 Response 的 content_type 属性改为 application/json
    """
    def __init__(self, data, **kwargs):
        content = JSONRenderer().render(data)
        kwargs['content_type'] = 'application/json'
        super(JSONResponse, self).__init__(content, **kwargs)


def all_books(request):
    all_books = Book.objects.all()
    all_books_json = BookSerializer(all_books, many=True)

    return JSONResponse(all_books_json.data)

编辑 tutorial/urls.py

from myapp.views import all_books

urlpatterns = [
    ......
    url(r'^api/all', all_books, name="all_books"),
]

一个包含了全部 Book 实例的 API 就在这里:http://127.0.0.1:8000/api/all

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,098评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,213评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,960评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,519评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,512评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,533评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,914评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,574评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,804评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,563评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,644评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,350评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,933评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,908评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,146评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,847评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,361评论 2 342

推荐阅读更多精彩内容