Django-Rest-Framework
Django-Rest框架是构建Web API强大而灵活的工具包。
简单粗暴，直奔主题。
pip install django pip install djangorestframework pip install pygments # 代码显示高亮
pip安装好需要的工具包之后，我们就开始创建一个框架。
打开终端。 cd ~ 切换到根目录下， (那个目录页可以，看自己想往哪里创建) django-admin.py startproject test_restframework # 创建工程 创建好之后切换进工程里边。 cd test_restframework
工程已经创建好了，需要cd进工程里边，关键是manage.py在工程里边，我们就需要借用manage.py来进行其他的操作了。
给工程添加api
python manage.py startapp test_restapi # 创建api
创建好之后，接下来，我们需要对django框架进行一些设置了(settings.py)
进入工程目录(test_restframework)找到settings.py，点开找见(INSTALLD_APPS)这个配置元祖，然后添加
INSTALLD_APPS = (
...
'rest_framework',
'test_restframework.apps.SnippetsConfig', # 这里需要注意的就是 ，不添加有可能会出错
)
配置添加完成之后，接下来我们改创建model了。
目录： test_restapi/model.py
from django.db import models
from pygments.lexers import get_all_lexers
from pygments.styles import get_all_stylea
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',)
model模型已经建好， 我们还需要模型迁移，并同步数据库。
注意：同步数据库命令是在 test_restframework下执行 python manage.py makemigrations test_restapi python manage.py migrate
数据库已经同步了，我们还需要在Web API 上添加一些序列化和反序列化的实例的方法，例如 json ，我们可以通过声明序列化器来实现这一点，这些序列化器的工作方式与Django的表单相似，在test_restapi目录中创建一个serializer.py文件，添加以下代码。
from rest_framework import serializers
from test_restapi.models import Snipper, LANGUAGE_CHOICES, STYLE_CHOICES
class SnippetSerialiazer(zerializers.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):
return Snippet.object.create(**validated_data)
def update(self, instance, 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
serializer类的第一部分定义了被序列化反序列化的字段，create()和update()方法定义了在调用serializer.save()时如何创建或修改完全成熟的实例，
serializer类非常类似于django form类，它包括在不同的字段上的类似验证标志，如required、max_length和default。
字段标志还可以控制在某些情况下序列化程序的显示方式，比如向HTML呈现的情况。
使用序列化器
在使用之前我们需要进入Django-shell。
python manage.py shell
进入shell之后我们需要输入：
from test_restapi.models import Snippet from test_restapi.serializers import SnippetSerializer from rest_framework.renders 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()
# <Snippet: Snippet object>
我们还可以序列化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
将test_restapi/serializers.py文件里的代码替换为：
class SnippetSerializer(serializers.ModelSerializer):
class Meta:
model = Snippet
fields = ('id', 'title', 'code', 'linenos', 'language', 'style')
序列器有一个很好的属性，可以同过它来打印它的表示，来检查序列化器实例中所有的字段，打开 Django shell
python manage.py shell
from test_restapi.serializers import SnippetSerializer serializer = SnippetSerializer() print(repr(serializer))
重要的是要记住ModelSerializer类并没有做什么特别神奇的事情，它们只是创建序列化的快捷方式。
使用序列化器编写常规的django视图
目录： test_restapi/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
@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)
最后定义路由，将视图连接起来。
目录: test_restapi/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),
]
目录： test_restframework/urls.py
from django.conf.urls import url, include
urlpatterns = [
url(r'^', include('test_resrapi.urls')),
]
安装httpie，我们可以通过curl来测试api，但是httpie也是一种很友好的测试包。
pip install httpie
最后启动工程
python manage.py runserver
工程起来之后，打开浏览器，输入url就可以看到结果了。 ^.^
以上资料来自官网。如有 不明白之处，可以查询官网示例： http://www.django-rest-framework.org/tutorial/1-serialization/
