Django REST framework-学习日志-1-serializers

什么是REST

REST是一种设计规范，符合这种规范的API都可以称作RESTful API，那怎样的才算是符合，根据我自己的理解再加上在知乎上看过许多相关的信息，接用知乎上的以为用户的总结：看Url就知道要什么，看http method就知道干什么，看http status code就知道结果如何

编写RESTful API的第一步

serialization

from rest_framework import serializers
class SnippetSerializer(serializers.Serializer):
    title = serializers.CharField(required=False, allow_blank=True, max_length=100)
    code = serializers.CharField(style={'base_template': 'textarea.html'})
    linenos = serializers.BooleanField(required=False)


class SnippetModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = Snippet
        fields = ['id', 'title', 'code', 'linenos']

有两种方案可供选择，一种是继承serializers.Serializer类，另一种是继承serializers.ModelSerializer类，这两种只是用法不同，其他的都类似

使用serialization

当数据为一个结果集时，需要加上参数many=True,序列化后的数据会保存在serializer.data中

serializer = SnippetSerializer(Snippet.objects.all(), many=True)
serializer.data

使用serialization编写一个django视图

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)


@csrf_exempt
def snippet_list(request):
    """
    列出所有的code snippet，或创建一个新的snippet。
    """
    if request.method == 'GET':
        snippets = Snippet.objects.all()
        serializer = SnippetModelSerializer(snippets, many=True)
        return JSONResponse(serializer.data)

    elif request.method == 'POST':
        data = JSONParser().parse(request)
        serializer = SnippetModelSerializer(data=data)
        if serializer.is_valid():
            serializer.save()
            return JSONResponse(serializer.data, status=201)
        return JSONResponse(serializer.errors, status=400)

这与平常的编写方式几乎一样，判断请求方式然后返回相应的数据，完成以上部分，我们就编写出了一个简单的RESTful API