Django-rest 框架：教程1：序列化

介绍

本教程将介绍如何创建一个突出显示Web API的简单pastebin代码。在此过程中，它将介绍构成REST框架的各种组件，并让您全面了解所有内容如何组合在一起。

这个教程相当深入，所以你应该在开始之前获得一个cookie和一杯你最喜欢的啤酒。如果您只想快速浏览一下，请转到快速入门文档。

建立一个新的环境

在我们做任何其他事情之前，我们将使用virtualenv创建一个新的虚拟环境。这将确保我们的包配置与我们正在处理的任何其他项目保持良好隔离。

virtualenv env
source env/bin/activate

现在我们已经进入了virtualenv环境，我们可以安装我们的包需求。

pip install django
pip install djangorestframework
pip install pygments  # We'll be using this for the code highlighting

注意：要随时退出virtualenv环境，只需键入即可deactivate。有关更多信息，请参阅virtualenv文档。

入门

好的，我们已经准备好接受编码了。首先，让我们创建一个可以使用的新项目。

cd ~
django-admin startproject tutorial
cd tutorial

完成后，我们可以创建一个我们将用于创建简单Web API的应用程序。

python manage.py startapp snippets

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

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

好的，我们已经准备好了。

创建一个可以使用的模型

出于本教程的目的，我们将首先创建一个Snippet用于存储代码片段的简单模型。继续编辑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

创建一个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()
# <Snippet: Snippet object>

请注意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类正在复制Snippet模型中也包含的大量信息。如果我们能够使代码更简洁，那将是很好的。

与Django提供Form类和ModelForm类的方式相同，REST框架包括Serializer类和ModelSerializer类。

让我们看看使用ModelSerializer类重构我们的序列化程序。snippets/serializers.py再次打开文件，并SnippetSerializer使用以下内容替换该类。

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 snippets import views

urlpatterns = [
    path('snippets/', views.snippet_list),
    path('snippets/<int:pk>/', views.snippet_detail),
]

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

from django.urls import path, include

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

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

测试我们对Web API的第一次尝试

现在我们可以启动一个为我们的代码段服务的示例服务器。

退出shell ...

quit()

...并启动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 。Httpie是一个用Python编写的用户友好的http客户端。我们安装一下吧。

您可以使用pip安装httpie：

pip install httpie

最后，我们可以获得所有代码段的列表：

http http://127.0.0.1:8000/snippets/

HTTP/1.1 200 OK
...
[
  {
    "id": 1,
    "title": "",
    "code": "foo = \"bar\"\n",
    "linenos": false,
    "language": "python",
    "style": "friendly"
  },
  {
    "id": 2,
    "title": "",
    "code": "print \"hello, world\"\n",
    "linenos": false,
    "language": "python",
    "style": "friendly"
  }
]

或者我们可以通过引用其ID来获取特定代码段：

http http://127.0.0.1:8000/snippets/2/

HTTP/1.1 200 OK
...
{
  "id": 2,
  "title": "",
  "code": "print \"hello, world\"\n",
  "linenos": false,
  "language": "python",
  "style": "friendly"
}

同样，您可以通过在Web浏览器中访问这些URL来显示相同​​的json。

我们现在在哪里

到目前为止我们做得还不错，我们有一个序列化API，感觉非常类似于Django的Forms API，以及一些常规的Django视图。

我们的API视图目前没有做任何特别特别的事情，除了提供json响应之外，还有一些我们仍想清理的错误处理边缘情况，但它是一个正常运行的Web API。