返回目录
上一节: 快速开始
简介
本教程将介绍如何创建一个实现代码高亮显示的API。之后会介绍组成REST framework的几个组件，并让你理解各个组件之间是如何协同工作的。
这篇教程已经相当深入了，你应该在开始之前准备好一些饼干，或者你心爱的佳酿，如果你仅仅想快速浏览一下，那么可以去读快速开始文档。
Note：本节中的代码托管在Github的仓库中，地址为
tomchrisite/rest-framework—tutorial，完整的在线实现的沙盒版本，可以(点击此处)查看。
配置一个新的环境
在我们开始其他工作之前，需要创建一个新的虚拟环境，使用virtualenv，它能保证我们的项目所依赖的包，能与系统其他的包良好的隔离开来。
virtualenv env
source env/bin/activate
现在我们已经进入到虚拟环境中来了，现在可以开始安装依赖包了。
pip install django
pip install djangorestframework
pip install pygments # 我们将使用它来实现代码高亮
Note：任何时候想要退出虚拟环境，只需要键入
deactivate，如果需要获取更多信息，请查阅(virtualenv文档)。
现在开始
我们已经准备好开始编码了，第一件事，我们需要创建一个新的项目。
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',
)
好的，准备工作已经做完了。
创建一个模型类
根据该教程的需求，我们需要创建一个简单的Snippet模型类，用来存储代码片段，去编辑snippets/models.py文件：
Note：一篇优秀的练习代码应该是包含注释的，你在我们仓库中对应的代码中也会看到详细的注释，我们只是在此处不得不删除他们，以将目光聚焦到代码本身。
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',)
现在需要为snippet模型类创建一个初始的迁移脚本，然后进行首次的数据库同步操作。
python manage.py makemigrations snippets
python manage.py migrate
创建序列化器类（Serializer class）
我们开始使用Web API需要做的第一件事，就是提供一个可以将snippets实例序列化和反序列化成诸如json等表现形式的方法。我们可以通过生命一个序列化器来实现，序列化起的使用与Django中的forms使用方法十分类似，在snippet目录中新建一个文件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()方法后创建或修改合格实例的方法。
序列化器类（serializer class）与Django中的表单类（Form class）十分相似，同样包含了针对不同字段的验证器（validation），例如required，max_length和default。
字段标记也可以控制在特定情况下序列化后应该如何显示，例如当我们渲染HTML的时候，{‘base_template’:’textarea.html’}标记与在Form类中使用widget=widgets.Textarea效果相同。这对于控制可浏览的API如何显示特别有用，我们将在本教程的后面看到。
我们可以使用ModelSerializer节省一些时间，同样也会在后面看到，但是现在我们仍然明确的定义序列化器。
使用序列化器开始工作
在我们开始更深入的内容之前，先熟悉一下Serializer类，现在打开Django shell。
python manage.py shell
OK，等我们完成了一些模块的导入工作，就可以来创建一些代码片段用来测试了。
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原生的数据类型…
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()
#
注意到API的工作流程与表单有多么相似，这种相似性在使用我们的序列化器编写函数时会频繁出现。
除了模型类实例之外，我们同样可以序列化查询集（querysets）。在这样做之前我们需要给序列化器传入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 framework也同时提供了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')...
请记住，ModelSerializer并没有任何魔法，它只是一个创建序列化类的快捷方式：
- 自动确定的字段集。
-
create()和update()方法的默认实现。
使用序列化器写常规的Django视图
我们来看看使用我们新的Serializer 类怎样来写一些API试图，此时我们不再使用任何REST framework的其他特性，我们仅用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)
你可能已经注意到，由于我们在视图函数中允许客户端发送POST请求，我们需要关闭CSRF token功能，可以使用@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.conf.urls import url
from snippets import views
urlpatterns = [
url(r'^snippets/$', views.snippet_list),
url(r'^snippets/(?P[0-9]+)/$', views.snippet_detail),
]
我们还需要将urls和根url连接起来，在tutorial/urls.py文件中，将我们的snippet app 的路由添加进来。
from django.conf.urls import url, include
urlpatterns = [
url(r'^', include('snippets.urls')),
]
值得注意的是，还有一些边缘情况我们没有正确处理，如果客户端发送了不正确的json数据，或者请求包含了我们没有处理的请求方法，那么响应将会以500 server error结束，当然，我们以后会处理这种情况。
测试API
现在我们可以运行我们的服务器来测试snippets了。
退出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编写的客户端，对用户十分友好，让我们来安装它。
你可以使用pip安装：
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信息。
当前进度
到目前为止我们做的还不错，我们创建了一些与Django的Form API十分类似的Serializer API， 和一些常规的Django视图。
我们的API视图除了响应json数据之外并没有做其他的事情，我们还需要处理一些错误处理的情况，那需要一个功能性的API。
我们将会在第二部分的教程中看到如何进一步完善我们的项目。
下一节教程2-请求和响应(Requests and responses)