django-rest-framework笔记-序列化篇

一、搭建环境

#新建虚拟环境
virtualenv venv
source venv/bin/activate
#在虚拟环境中安装项目依赖库
cat requirements.txt

coreapi==2.3.1
django==1.11.4
django-filter==1.0.4
django-crispy-forms==1.6.1
django-guardian==1.4.9
httpie-0.9.9
Markdown==2.6.8
Pygments==2.2.0

pip install -r requirements.txt

二、创建项目,配置

#新建项目
django-admin startproject tutorial
#创建应用
cd tutorial
python manage.py startapp snippets

配置:

#将我们新建的snippets app和rest_framework添加到INSTALLED_APPS
INSTALLED_APPS = [
    ...
    ‘rest_framework‘,
    ‘snippets.apps.SnippetsConfig‘ #Djangp<1.9 替换为snippets
]

#数据库配置
DATABASES = {
    ‘default‘: {
        ‘ENGINE‘: ‘django.db.backends.mysql‘,
        ‘NAME‘: ‘rest‘, # database
        ‘USER‘: ‘root‘,
        ‘PASSWORD‘: ‘root‘,
        ‘HOST‘: ‘192.168.1.115‘,
        ‘OPTIONS‘: {
            ‘autocommit‘: True,
        }
    }
}

注意:如果mysql-python安装不上去,可以使用pymysql替代

在tutorial包中的__init__.py 将pymysql转为mysql-python

try:
    import pymysql
    pymysql.install_as_MySQLdb()
except ImportError:
    pass

三、模型

编辑文件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, 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 snippets
python manage.py migrate

四、序列化

新建snippets/serializers.py文件

#!/usr/bin/env python
# coding:utf-8
from __future__ import absolute_import, print_function, division
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):
        """
        Create and return a new `Snippet` instance, given the validated data.
        """
        return Snippet.objects.create(**validated_data)

    def update(self, instance, validated_data):
        """
        Update and return an existing `Snippet` instance, given the 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

五、视图

编辑snippets/views.py

# -*- coding: utf-8 -*-
from __future__ import unicode_literals
# Create your views here.

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

@csrf_exempt
def snippet_list(request):
    """
    List all code snippets, or create a new snippet.
    """
    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)

@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)

六、路由

创建app路由

新建文件snippets/urls.py

#!/usr/bin/env python
# coding:utf-8
from __future__ import absolute_import, print_function, division
from django.conf.urls import url
from snippets import views

urlpatterns = [
    url(r‘^snippets/$‘, views.snippet_list),
    url(r‘^snippets/(?P<pk>[0-9]+)/$‘, views.snippet_detail),
]

编辑项目路由(tutorial/urls.py)

"""rest_demo URL Configuration

The `urlpatterns` list routes URLs to views. For more information please see:
    https://docs.djangoproject.com/en/1.11/topics/http/urls/
Examples:
Function views
    1. Add an import:  from my_app import views
    2. Add a URL to urlpatterns:  url(r‘^$‘, views.home, name=‘home‘)
Class-based views
    1. Add an import:  from other_app.views import Home
    2. Add a URL to urlpatterns:  url(r‘^$‘, Home.as_view(), name=‘home‘)
Including another URLconf
    1. Import the include() function: from django.conf.urls import url, include
    2. Add a URL to urlpatterns:  url(r‘^blog/‘, include(‘blog.urls‘))
"""
from django.conf.urls import url, include
from django.contrib import admin

urlpatterns = [
    url(r‘^admin/‘, admin.site.urls),
    url(r‘^‘, include(‘snippets.urls‘)),
]

七、插入数据

python manage.py shell

In [1]: from snippets.models import  Snippet

In [2]: from snippets.serializers import  SnippetSerializer

In [3]: from rest_framework.renderers import  JSONRenderer

In [4]: from rest_framework.parsers import  JSONParser

In [5]: snippet = Snippet(code=‘foo = "bar"\n‘)

In [6]: snippet.save()

In [7]: snippet = Snippet(code=‘print "Hello, Django-restframework"\n‘)

In [8]: snippet.save()

In [9]: serializer = SnippetSerializer(snippet)

In [10]: serializer.data
Out[10]:
ReturnDict([(‘id‘, 2),
            (‘title‘, u‘‘),
            (‘code‘, u‘print "Hello, Django-restframework"\n‘),
            (‘linenos‘, False),
            (‘language‘, ‘python‘),
            (‘style‘, ‘friendly‘)])

In [11]: content = JSONRenderer().render(serializer.data)

In [12]: content
Out[12]: ‘{"id":2,"title":"","code":"print \\"Hello, Django-restframework\\"\\n"
,"linenos":false,"language":"python","style":"friendly"}‘

八、测试-httpie

# http http://127.0.0.1:8000/snippets/
HTTP/1.0 200 OK
Content-Length: 248
Content-Type: application/json
Date: Thu, 17 Aug 2017 15:00:56 GMT
Server: WSGIServer/0.1 Python/2.7.12
X-Frame-Options: SAMEORIGIN

[
    {
        "code": "foo = \"bar\"\n",
        "id": 1,
        "language": "python",
        "linenos": false,
        "style": "friendly",
        "title": ""
    },
    {
        "code": "print \"Hello, Django-restframework\"\n",
        "id": 2,
        "language": "python",
        "linenos": false,
        "style": "friendly",
        "title": ""
    }
]

浏览器访问http://127.0.0.1:8000/snippets/

[{"id": 1, "title": "", "code": "foo = \"bar\"\n", "linenos": false, "language": "python", "style": "friendly"}, {"id": 2, "title": "", "code": "print \"Hello, Django-restframework\"\n", "linenos": false, "language": "python", "style": "friendly"}]
时间: 2024-08-04 21:17:13

django-rest-framework笔记-序列化篇的相关文章

Django Rest Framework(2)-----序列化详解(serializers)

REST framework中的序列化类与Django的Form和ModelForm类非常相似.我们提供了一个Serializer类,它提供了一种强大的通用方法来控制响应的输出,以及一个ModelSerializer类,它为创建处理模型实例和查询集的序列化提供了有效的快捷方式. Serializers 序列化器允许把像查询集和模型实例这样的复杂数据转换为可以轻松渲染成JSON,XML或其他内容类型的原生Python类型.序列化器还提供反序列化,在验证传入的数据之后允许解析数据转换回复杂类型.不仅

django rest framework之序列化

首先找到models文件,然后里面写上内容,自定义 class UserGroup(models.Model): title = models.CharField(max_length=32) class UserInfo(models.Model): name = models.CharField(verbose_name="姓名",max_length=255) age = models.IntegerField(verbose_name="年龄") choic

Django REST framework之序列化组件以及源码分析+全局、局部Hook

序列化两大功能 a.对queryset类型进行序列化 b.对用户请求的数据进行校验 a.对queryset类型进行序列化 举例说明: 表设计 1 from django.db import models 2 3 4 class UserGroup(models.Model): 5 title = models.CharField(max_length=32) 6 7 8 class UserInfo(models.Model): 9 user_type_choices = ( 10 (1, '普

DRF(Django Rest Framework)序列化组件接口使用和接口设计--!GET接口设计!

定义序列化器(本质就是一个类),一般包括模型类的字段,有自己的字段类型规则.实现了序列化器后,就可以创建序列化对象以及查询集进行序列化操作,通过序列化对象.data来获取数据(不用自己构造字典,再返回Json数据) INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.me

1、Django REST framework 理解

Web应用模式 1 .前后端不分离:在前后端不分离的应用模式中,前端页面看到的效果都是由后端控制,由后端渲染页面或重定向,也就是后端需要控制前端的展示,前端与厚度那的耦合度很高. 这种应用模式比较合适纯网页应用,但是后端对接APP时,App可能并不需要后端返回一个HTML网页,二仅仅是数据本身,所以后端原本返回网页的接口不在适用前端APP应用,为了对接APP后端嗨需再开发一套接口2.前后端分离:在前后端分离的应用模式中,后端仅返回前端所需的数据,不在渲染HTML页面,不在控制前端的效果,只用前端

轻轻松松学会 DRF Django REST framework

DRF Django REST framework 之 APIView(一) DRF Django REST framework 之 解析器(二) DRF Django REST framework 之 序列化(三) DRF Django REST framework 之 视图组件(四) 持续更新中.... 原文地址:https://www.cnblogs.com/pungchur/p/12028316.html

Django Rest framework序列化流程

目录 一 什么是序列化 二 Django REST framework配置流程之Serializer 三 Django REST framework配置流程之ModelSerializer 一 什么是序列化 序列化模型与序列化关系模型 序列化模型,顾名思义,即对 models 里的数据模型作序列化. 而序列化关系模型则是对 models 里数据模型中带有关系的如 ForeignKey, ManyToManyField 和 OneToOneField 字段作序列化. Django Rest Fra

Django Rest Framework --- 序列化组件

一.序列化组件的作用 在前后端分离开发时,前端与后端用来交互的数据的格式是一致的(数据格式为字符串的json数据),于是后端程序员在传递数据时,便要将数据封装成符合格式的数据,如果不借助方法,手动进行数据封装,会非常的浪费时间,在Django rest framework中的序列化组件帮我们解决了这个问题. 二.Django自带的序列化组件 from django.core import serializers def test(request): book_list = Book.object

Django REST framework序列化

Django REST framework序列化 开发我们的Web API的第一件事是为我们的Web API提供一种将代码片段实例序列化和反序列化为诸如json之类的表示形式的方式 models部分 from django.db import models class Book(models.Model): title = models.CharField(max_length=32) price = models.IntegerField() pub_date = models.DateFie