Django-REST:002-API接口序列化

RESTful风格下，比较充分的利用了HTTP1.1标准中规定的集中请求方式

l GET:用于提交向服务器获取数据的请求

l POST:用于提交数据给服务器进行数据更新的请求

l PUT:用于提交数据给服务器进行数据添加的请求

l DELETE:用于提交给服务器删除条件数据的请求

在这样的处理风格下，目前更加适合项目开发并且成本较低的一种比较流行的开发模式：项目的前后端分离结构模型的优势更加突出，通过RESTful风格指定的格式定义不同的数据处理的请求方式，后端只需要提供对应的接口，前端视图部分负责调用进行数据展示；数据的交互全部交给异步调用进行实现，能最大程度的发挥项目开发过程中开发人员的能力！

下面是一个基本案例[参考官方文档整理]，了解一下RESTful在Django项目中的主要工作流程和操作方式

1. 创建案例项目

执行命令创建项目


django-admin startproject myrest_ex02

进入项目根目录中，执行命令创建一个应用：用于进行代码文件描述的应用


django-admin startapp snippet

2. 配置开发环境

确保在django的基础上，安装restful需要的各种依赖包


pip install django

pip install djangorestframework # restful框架

pip install pygments # 代码文件描述模块

打开项目配置文件settings.py，添加rest框架模块和我们的应用程序模块


INSTALLED_APPS = [
 …… **'rest_framework'**, **'snippet.apps.SnippetConfig'**,
]

3. 数据模型定义

打开snippet应用的数据模型定义模块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, default='')
    # 代码片段
    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 snippet

python manage.py migrate

4. 数据模型序列化处理

在snippet应用中，添加一个序列化模块，用于进行数据模型对象的序列化操作

在myrest_ex02/snippet/目录下创建文件：serializers.py

# coding:utf-8

from rest_framework import serializers
from .models import Snippet, LANGUAGE_CHOICES, STYLE_CHOICES


class SnippetSerializer(serializers.ModelSerializer):
    class Meta:
        model = Snippet
        fields = ['id', 'title', 'code', 'linenos', 'language', 'style']

PS:序列化操作本身提供了一个基本接口serializers.Serializer类型，但是这个类型本身提供的实现机制不利于代码的复用性，封装的ModelSerializer更加友好的提供了序列化的实现方式更加友好！

5. 交互测试

已经开发好了一部分序列交互的部分，我们接下来就可以通过django shell交互方式进行数据对象的序列化操作测试了，测试通过之后继续开发视图部分代码。

执行命令进入shell交互窗口

python manage.py shell

(1) 在交互窗口中导入我们需要的模块


from snippet.models import Snippet

from snippet.serializers import SnippetSerializer

from rest_framework.renderers import JSONRenderer

from rest_framework.parsers import JSONPerser

(2) 添加数据到数据库


>>> snippet = Snippet(code='name = "jerry"')

>>> snippet.save()

>>>

>>> snippet2 = Snippet(code='print("hello python")')

>>> snippet.save()

(3) 序列化对象数据


>>> serializer = SnippetSerializer(snippet2)

>>> serializer.data

{'id': None, 'title': '', 'code': 'print("hello python")', 'linenos': False, 'language': 'python', 'sty

le': 'friendly'}

>>> **serializer2 = SnippetSerializer(snippet)**

>>> **serializer2.data**

{'id': 3, 'title': '', 'code': 'name = "jerry"', 'linenos': False, 'language': 'python', 'style': 'frie

ndly'}

(4) JSON格式化序列数据

通过JSON格式化渲染的数据，就是最终可以交互的JSON字符串数据


>>> content = JSONRenderer().render(serializer.data)

>>>

>>> content

b'{"id":null,"title":"","code":"print(\\"hello python\\")","linenos":false,"language":"python","style":

"friendly"}'

(5) 反序列化JSON数据

反序列化在WEB应用中，主要用于解析视图客户端提交的JSON数据，转化成数据对象之后进行CRUD的操作


>>> from django.utils.six import BytesIO

>>>

>>> stream = BytesIO(content)

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

>>>

>>> serializer = SnippetSerializer(data=data)

>>> serializer.is_valid()

True

>>>

>>> serializer.save()

<Snippet: Snippet object (4)>

(6) 序列化查询结果集

在实际项目操作过程中，我们在Django项目里面操作的往往都是QuerySet查询结果集

对于查询结果集的序列化处理方式如下


>>> res = SnippetSerializer(Snippet.objects.all(), many=True)

>>> res.data

[OrderedDict([('id', 1), ('title', ''), ('code', 'foo="bar"\n'), ('linenos', False), ('language', 'pyth

on'), ('style', 'friendly')]), OrderedDict([('id', 2), ('title', ''), ('code', 'print("hello world")\n'

), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 3), ('title

', ''), ('code', 'name = "jerry"'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])

, OrderedDict([('id', 4), ('title', ''), ('code', 'print("hello python")'), ('linenos', False), ('langu

age', 'python'), ('style', 'friendly')])]

6. 视图函数：API数据接口

经过第5步的交互测试，已经完成了对数据的处理方式的基本操作测试

接下来开始开发视图交互函数，也就是给其他调用的客户端提供数据的API接口函数！

(1) 数据列表接口函数——snippet_list

打开项目应用的视图处理模块：snippet.views

开发数据列表接口函数


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 .models import Snippet

from .serializers import SnippetSerializer

@csrf_exempt

def snippet_list(reuqest):

    if request.method == “GET”:

         # 查询所有数据

         snippets = Snippet.objects.all()

         # 序列化数据

         serializers = SnippetSerializer(snippets, many=True)

         # 返回数据
         return JsonResponse(serializers.data, safe=False)

    elif request.method == “POST”:

        # 解析提交的数据

          data = JSONParser().parse(request)

        # 反解析序列数据

          serializers = SnippetSerializer(data=data)

       # 验证并保存数据

          if serializers.is_valid():

                  serializers.save()

                # 返回视图页面

                  return JsonResponse(serializer.data, status=201)

            return JsonResponse(serializer.errors, status=400)

(2) 对象数据增删改API接口函数开发

定义一个接口函数，通过request.method直接判断进行不同请求方式的处理


@csrf_exempt

def snippet_detail(request, pk):

# 首先查询得到数据对象

try:

  snippet = Snippet.objects.get(pk=pk)

except Snippet.DoesNotExist:

  return HttpResponse(status=404)

# 获取单个数据的操作

if request.method == “GET”:

# 序列化数据

  serializers = SnippetSerializer(snippet)

  return JsonResponse(serializers.data)

# 提交数据的操作

elif request.method == “PUT”:

# 反解析数据

  data = JSONParser().parse(request)

# 序列化操作

  serializers = SnippetSerializer(data=data)

# 验证有效性并存储

  if serializers.is_valid():

  serializers.save()

# 返回视图处理界面

  return JsonResponse(serializers.data)

  return JsonResponse(serializers.errors, status=400)

# 删除数据的操作

elif request.method ==”DELETE”:

  snippet.delete()

  return HttpResponse(status=204)

7. 运行测试

(1) 浏览器测试

执行命令运行项目


python manage.py shell

浏览器访问http://localhost:8000/snippet/ 查看所有数据列表

image.png

浏览器访问http://localhost:8000/snippet/1/查看指定的对象数据

|

image.png

|

其他请求方式通过工具进行测试验证

(2) Postman测试工具

l get测试

|

image.png

|

l delete测试

|

image.png

|

再次查询

|

image.png

|

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 214,776评论 6赞 496
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 91,527评论 3赞 389
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 160,361评论 0赞 350
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 57,430评论 1赞 288
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 66,511评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 50,544评论 1赞 293
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,561评论 3赞 414
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,315评论 0赞 270
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,763评论 1赞 307
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,070评论 2赞 330
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,235评论 1赞 343
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,911评论 5赞 338
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,554评论 3赞 322
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,173评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,424评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,106评论 2赞 365
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,103评论 2赞 352

推荐阅读更多精彩内容

  • 周代兴盛之谜
    我们都知道，周朝是中国历史上存在时间最长的朝代，有这800多年的历史，皇帝共传下了三十代，产生了三十七个帝...
    伪文艺的俏小生阅读 315评论 0赞 0
  • 海天一色
    雨后的厦门蓝
    amanda917阅读 174评论 0赞 0
  • 重写UIButton,布局imageView和textLabel
    contentRect 指的是当前button的contentRect.如果没有设置Edge,则即为button的...
    歌手的剑阅读 253评论 0赞 0
  • 大雨
    窗外大雨倾盆。 是真的要离开的时候了。没想过会这么落寞。 湿漉漉的头发。湿漉漉的心情。 我似乎找到了最近不停堕落看...
    老二Y阅读 243评论 0赞 0