GitHub Search Django REST framework

Tutorial 1: Serialization

Introduction

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

该教程相当深入，所以你应该在开始之前准备一些曲奇饼干和饮料。 如果您只想快速浏览一下，则应该转到quickstart文档。

注意：本教程的代码可以在GitHub的tomchristie / rest-framework-tutorial repository中找到。 The completed implementation is also online as a sandbox version for testing, available here.

建立一个新的环境

在我们做其他事情之前，我们将使用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

Note: 要随时退出virtualenv环境，只需键入 deactivate 。 有关更多信息，请参阅virtualenv文档。

Getting started

好的，我们已经准备好编写代码。 开始，让我们创建一个新的项目。

cd ~
django-admin.py 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',
)

好的，我们已准备好下一步。

Creating a model to work with

为了本教程的目的，我们将首先创建一个简单的用于存储代码片段的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

Creating a Serializer class

我们开始使用Web API的第一件事就是提供一种将snippet实例序列化和反序列化为表示形式（如json）的方法。 我们可以通过声明与Django的form非常相似的序列化程序来做到这一点。 在名为serializers.py的snippets目录中创建一个文件并添加以下内容。

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'}标志等同于在Django Form类中使用widget = widgets.Textarea。 这对于控制如何显示可浏览的API特别有用，正如我们稍后在教程中看到的那样。

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

Working with Serializers

在我们继续前进之前，我们将熟悉使用我们的新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()

现在我们有几个snippet实例可供操作。 我们来看看序列化其中一个实例。

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本地数据类型...

from django.utils.six import BytesIO

stream = 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')])]

Using 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')

序列化程序拥有的一个不错的属性是，您可以通过打印其表示来检查序列化程序实例中的所有字段。 用python manage.py shell打开Django 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')...

重要的是要记住ModelStrializer类不做任何特别神奇的事情，它们只是创建序列化器类的快捷方式：

  • An automatically determined set of fields.
  • Simple default implementations for the create() and update() methods.

Writing regular Django views using our Serializer

让我们看看我们如何使用我们的新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的根将成为支持列出所有现有snippets或创建新snippet的view。

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

我们还需要一个与单个snippet相对应的view，并可用于检索，更新或删除snippet。

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

最后我们需要把这些views联系起来。 创建snippets / urls.py文件：

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文件中连接根urlconf以包含我们的snippet应用的URLs。

from django.conf.urls import url, include

urlpatterns = [
    url(r'^', include('snippets.urls')),
]

值得注意的是，目前我们还没有处理好几个边缘案例。 如果我们发送格式不正确的json，或者如果请求使用的是视图无法处理的方法，那么我们最终会得到500“服务器错误”的响应。 尽管如此，现在还是可以的。

Testing our first attempt at a Web API

现在我们可以启动服务于我们snippet的示例服务器。

退出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。

Where are we now

到目前为止，我们做得很好，我们有一个序列化API，它与Django的Forms API以及一些常规的Django视图非常相似。

除了服务json响应之外，我们的API视图目前不做任何特别特别的事情，并且还有一些我们仍希望清理的错误处理边缘案例，但它是一个正常运行的Web API。

我们将看看我们如何开始进入教程的第2部分中的内容。