Django Restful Framework序列化API

1.搭建一个新环境

virtualenv env
source env/bin/activate(Linux 下激活虚拟环境)
activate env(Windows 下激活虚拟环境)

退出虚拟环境：
deactivate

2.安装需求的包

pip install django
pip install djangorestframework
pip install pygments

3.搭建Django项目，我们用它来创建简单的WebAPI

cd ~
django-admin startproject tutorial
cd tutorial

#创建应用程序
python manage.py startapp snippets

4.我们需要添加我们新的snippets应用和rest_frameword应用到INSTALLED_APPS。
让我们编辑tutorial/settings.py文件：

INSTALLED_APPS = (
    ...
    'rest_framework',
    'snippets.apps.SnippetsConfig',
)

至此，我们以及准备好了项目所需的环境。
创建要使用的模型

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 mall
python manage.py migrate

创建一个Serializer类
我们需要开始使用Web API的第一件事是提供一种将代码段实例序列化为表示形式的方法json。我们可以通过声明与Django表单非常相似的序列化器来完成此操作。在snippets的目录中创建一个文件，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):
        """
        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

序列化程序类的第一部分定义了序列化/反序列化的字段。该create(）和update()方法定义实例如何在创建或修改时调用serializer.save()进行保存。

序列化程序类与Django Form类是否类似，并且在各个字段中包含类似的验证标志，例如required,max_length和default。

字段标志还可以控制在某些情况下的应该如何显示序列化程序，例如在呈现HTML时。{'base_template':'textarea.html'}上面的标志相当于widget=widgets.Textarea在Django Form类上使用。这对于控制可浏览API的显示方式特别有用，我们将在本教程后面看到。

我们实际上也可以通过使用ModelSerializer类来节省一些时间，我们稍后会看到，但是现在我们将保持序列化器定义的显式。

使用序列化程序
在我们继续之前，我们将熟悉使用我们的新Serializer类。让我们进入Django Shell。

python manage.py shell

好的，在我们完成一些导入，让我们创建几个代码片段来处理。

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"\n')
snippet.save()

snippet = Snippet(code='print "hello, world"\n')
snippet.save()

我们现在有几个片段实例可供使用。我们来看看序列化其中一个实例。

serializer = SnippetSerializer(snippet)
serializer.data
# {'id': 2, 'title': u'', 'code': u'print "hello, world"\n', 'linenos': False, 'language': u'python', 'style': u'friendly'}

此时我们已将模型实例转换为Python本机数据类型。为了完成序列化过程，我们将数据渲染到json。

content = JSONRenderer().render(serializer.data)
content
# '{"id": 2, "title": "", "code": "print \\"hello, world\\"\\n", "linenos": false, "language": "python", "style": "friendly"}'

反序列化是类似的。首先，我们将流解析为Python本机数据类型：

import io

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

然后我们将这些本机数据类型还原为完全填充的对象实例。

serializer = SnippetSerializer(data=data)
serializer.is_valid()
# True
serializer.validated_data
# OrderedDict([('title', ''), ('code', 'print "hello, world"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])
serializer.save()
#

请注意API与表单的相似程度。当我们开始编写使用我们的序列化程序的视图时，相似性应该变得更加明显。

我们还可以序列化查询集而不是模型实例。为此，我们只需many=True在序列化程序参数中添加一个标志。

serializer = SnippetSerializer(Snippet.objects.all(), many=True)
serializer.data
# [OrderedDict([('id', 1), ('title', u''), ('code', u'foo = "bar"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 2), ('title', u''), ('code', u'print "hello, world"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 3), ('title', u''), ('code', u'print "hello, world"'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])]

使用ModelSerializers
我们SnippetSerializer class 正在复制Snippet模型中也包含的大量信息。如果我们能够使代码更加简洁，那就太好了。
与Django提供 Form 类和 ModelForm类的方式相同,REST框架包括Serializer 类和ModelSerializer 类。
让我们看看使用ModelSerializer 类重构我们的序列化程序。

snippets/serializers.py，使用ModelSerializer替换serializer中的内容。

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

序列化程序具有一个不错的属性是，您可以通过打印其表示来检查序列化程序实例中所有的字段。打开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 类没有做任何特别神奇的事情，它们只是创建序列化器类的快捷方式：

自动确定的字段集
create()和update()方法的简单默认实现

实现我们的Serializer编写常规Django视图
让我们看看如何使用我们的新Serializer类编写一些API视图。目前我们不会使用任何REST框架的其他功能，我们只会将视图写成常规Django视图。

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的根目录是支持列出所有代码段或创建新代码段的视图。

@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令牌的客户端POST到此视图，所以我们需要将视图标记为csrf_exempt。这不是您通常想要做的事，REST框架视图实际上使用的行为比这更加明智，但它现在可以用于我们的目的。

我们还需要一个与单个代码段相应的视图，并可用于检索，更新或者删除代码段。

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

最后，我们需要连接这些视图。创建snippets/urls.py文件。

from django.urls import path
from snippet import views

urlpatterns=[
  path('snippets/',views.snippets_list),
  path('snippets/',views.snippets_detail),
]

我们还需要连接tutorial/urls.py文件中的根urlconf,以包含我们代码段应用程序中的URL。

from django.urls import path, include

urlpatterns = [
    path('', include('snippets.urls')),
]

值得注意的是，目前还有一些我们没有正确处理的边缘情况。如果我们发送错误格式的json，或者使用视图无法处理的方法发出请求，那么我们最终会得到500"服务器错误"响应。不过，现在这样做.

测试我们对Web API的第一次尝试
现在我们可以启动一个为我们的代码段服务的实例服务器。
退出shell
并启动Django的开发服务器。

python manage.py runserver

Validating models...

0 errors found
Django version 1.11, using settings 'tutorial.settings'
Development server is running at http://127.0.0.1:8000/
Quit the server with CONTROL-C.

在另一个终端窗口中，我们可以测试服务器。
我们可以使用curl或httpie测试我们的API

Django Restful Framework序列化API

你可能感兴趣的:(Django Restful Framework序列化API)