djangorestframework框架笔记（1) 实例化对象

最新推荐文章于 2023-07-16 18:51:33 发布

weixin_34138521

最新推荐文章于 2023-07-16 18:51:33 发布

阅读量143

点赞数

文章标签： python json shell

原文链接：https://my.oschina.net/u/215677/blog/657018

版权

2019独角兽企业重金招聘Python工程师标准>>>

安装环境

pip install django pip install djangorestframework pip install pygments

###创建项目我们现在需要创建一个django的项目,下面的代码的功能是创建一个名为tutorial的django项目

cd ~ django-admin.py startproject tutorial cd tutorial

项目创建完成之后我们需要创建一个简单的web api的应用程序

python3 manage.py startapp snippets

我们编辑settings.py文件，将新程序和rest_framework应用添加到INSTALLED_APPS里面

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

###创建一个数据模型我们将新创建的项目加载之后我们现在需要做的是创建一个数据的模型，我们在snippets/models.py添加一个Snippet的模型

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

**在第一次创建模型之后，我们需要对其进行迁移和同步，将其更改写入到数据库当中 **

python3 manage.py makemigrations snippet
python3 manage.py migrate

创建一个序列化类

在使用这些模型之前，我们需要提供一个序列化和反序列化的方法，将snippet的实例转换成json的形式。我们创建一个新的文件serializers.py，并且添加下面的代码.

from rest_framework import serializers

from snippets.models import Snippet,LANGUAGE_CHOICES,STYLE_CHOICES

class SnippetSerializer(serializers.Serializer):

    """创建Snippets的序列化类"""

    pk=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):
        """通过传一个validated_data来创建和返回一个'Snippet'的实例"""
        return Snippet.objects.create(**validated_data)
    def update(self,instance, validated_data):
        """通过传入validated_data来更新已有的Snippet实例

        :validated_data: TODO
        :returns: TODO

        """
        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是根据传入的validated_data创建一个新的实例，而update是根据传入的数据进行更新已有的实例。

serializer类非常类似django的表单类，提供了一些创建时的验证标记，比如required,max_length和default 在字段标识的时候可以指定serializer以怎样的形式进行显现，比如以html的方式.

有关{'bash_template':'textarea.html'}的等同于django 表单类中的widget=widgets.Textarea,这种方式在构建可浏览的api时特别的有用.

使用Serializers

在进一步操作之前，我们通过shell的方式来使用serializer类

python3 manage.py shell

下面的代码段让我们创建了两个snippets实例

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的实例，我们通过SnippetSerializer来对其进行序列化,并且打印序列化之后的数据.

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

同样的我们可以以JSON的方式进行数据的显示

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

反序列化也是类似的，我们读取相应的数据并且进行数据的解析成特定类型的数据。

from django.utils.six import BytesIO

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

###在view中实现Serializer 我们通过创建一个HttpResponse类来将数据通过json的方式进行呈现. 将下面的代码添加到snippets/views.py当中。

from django.http import HttpResponse
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

class JSONResponse(HttpResponse):
    """
    An HttpResponse that renders its content into JSON.
    """
    def __init__(self, data, **kwargs):
        content = JSONRenderer().render(data)
        kwargs['content_type'] = 'application/json'
        super(JSONResponse, self).__init__(content, **kwargs)

现在我们编写一个视图来显示所有的snippet列表

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

    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 解除跨域 post 限制我们同样需要提供一个对特定的snippet进行操作的视图，能够对其进行检索、更新或删除

最后我们需要在snippets里面创建一个urls.py的文件 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文件，使其包含snippet的urls

from django.conf.urls import url, include

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

###测试实例通过运行下面的命令来启动django服务

python manage.py runserver Performing system checks... System check identified no issues (0 silenced). April 11, 2016 - 13:51:47 Django version 1.9.5, using settings 'tutorial.settings' Starting development server at http://127.0.0.1:8000/ Quit the server with CONTROL-C.

我们通过安装httpie来测试