Rest-framework专栏讲解(九)：解析器与解析响应

2023-11-15 08:57:46

前言

在上一篇文章中，我们介绍了如何使用Django REST framework来创建REST API。在本文中，我们将重点讲解解析器和解析响应。解析器用于将请求正文转换为Python数据，解析响应用于将Python数据转换为响应正文。我们还将讨论内容协商和媒体类型，以及如何使用默认渲染器和自定义渲染器来控制响应格式。最后，还将介绍如何使用序列化器和视图集来简化REST API的开发。

解析器

解析器用于将请求正文转换为Python数据。REST framework提供了多种内置解析器，可以处理各种类型的请求正文，包括JSON、XML、表单数据和多部分数据。

要指定要使用的解析器，可以在视图中使用parser_classes属性。例如，以下代码指定了JSON解析器和表单数据解析器：

class MyView(APIView):
    parser_classes = [JSONParser, FormParser]

如果请求正文的Content-Type头指定了解析器可以处理的媒体类型，那么该解析器将被用于解析请求正文。否则，将引发ParseError异常。

解析响应

解析响应用于将Python数据转换为响应正文。REST framework提供了多种内置解析器，可以处理各种类型的响应正文，包括JSON、XML和HTML。

要指定要使用的解析器，可以在视图中使用renderer_classes属性。例如，以下代码指定了JSON解析器和XML解析器：

class MyView(APIView):
    renderer_classes = [JSONRenderer, XMLRenderer]

如果请求头中的Accept头指定了解析器可以处理的媒体类型，那么该解析器将被用于解析响应正文。否则，将引发ValidationError异常。

内容协商和媒体类型

内容协商是一种机制，允许客户端和服务器协商响应的格式。在HTTP请求中，客户端可以使用Accept头来指定它可以接受的媒体类型。在HTTP响应中，服务器可以使用Content-Type头来指定响应正文的媒体类型。

如果客户端和服务器协商的媒体类型不匹配，那么服务器将返回一个406 Not Acceptable错误。

默认渲染器和自定义渲染器

REST framework提供了两种类型的渲染器：默认渲染器和自定义渲染器。默认渲染器是内置的，可以处理各种类型的响应正文。自定义渲染器是用户定义的，可以用来实现自定义的响应格式。

要使用自定义渲染器，可以在视图中使用renderer_classes属性。例如，以下代码指定了一个自定义的JSON渲染器：

class MyJSONRenderer(JSONRenderer):
    def render(self, data, accepted_media_type=None, renderer_context=None):
        return json.dumps(data, indent=4)

class MyView(APIView):
    renderer_classes = [MyJSONRenderer]

序列化器和视图集

序列化器是一种工具，可以将Python数据转换为可序列化的格式，例如JSON或XML。视图集是一种类，它封装了视图的逻辑和行为。

使用序列化器和视图集可以简化REST API的开发。例如，以下代码定义了一个视图集，它使用序列化器来处理JSON请求和响应：

from rest_framework import viewsets, serializers

class MyModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = MyModel
        fields = '__all__'

class MyViewSet(viewsets.ModelViewSet):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer