如何在Django REST框架中返回自定义JSON？

在这篇文章中，我们将创建基于类的视图，并将其与序列化器类相结合，为每个HTTP请求返回JSON表示。对于我们的基于类的视图，我们将使用一组通用的视图，这有助于实现最小的代码行。

通用类和视图集
与关系资源互动的HTTP请求

通用类和视图集

我们将利用通用类视图来实现get、post、delete、put和patch方法。为此，我们需要利用rest_framework.generics模块中的两个__泛型类视图。它们是

ListCreateAPIView
RetrieveUpdateDestroyAPIView

ListCreateAPIView类视图实现了get方法（检索一个queryset的列表）和post方法（创建一个模型实例）。而且，RetrieveUpdateDestroyAPIView类视图实现了get（检索一个模型实例），delete（删除一个模型实例），put（完全更新一个模型实例）和patch（部分更新一个模型实例）。

在Django REST框架中，这两个通用视图被实现为混合类。ListCreateAPIView使用了来自rest_framework.mixins模块的ListModelMixin和CreateModelMixin以及来自rest_framework.generics模块的_GenericAPIView。我们来看看它的声明。

class ListCreateAPIView(mixins.ListModelMixin, 
                        mixins.CreateModelMixin, GenericAPIView):

RetrieveUpdateDestroyAPIView使用了来自rest_framework.mixins模块的RetrieveModelMixin、UpdateModelMixin和DestroyModelMixin以及来自rest_framework.enerics模块的_GenericAPIView。我们来看看它的声明。

class RetrieveUpdateDestroyAPIView(mixins.RetrieveModelMixin, 
                                   mixins.UpdateModelMixin, 
                                   mixins.DestroyModelMixin, 
                                   GenericAPIView):

现在，让我们回到我们的RESTFul网络服务代码，创建所需的一组基于Django类的视图。你可以打开restpi\robots\views.py Python文件，用下面的代码替换它。

from django.shortcuts import render
  
from rest_framework import generics
from rest_framework.response import Response
from rest_framework.reverse import reverse
  
from robots.models import RobotCategory
from robots.models import Manufacturer
from robots.models import Robot
  
from robots.serializers import RobotCategorySerializer
from robots.serializers import ManufacturerSerializer
from robots.serializers import RobotSerializer
  
class ApiRoot(generics.GenericAPIView):
    name = 'api-root'
    def get(self, request, *args, **kwargs):
        return Response({
            'robot-categories': reverse(RobotCategoryList.name, request=request),
            'manufacturers': reverse(ManufacturerList.name, request=request),
            'robots': reverse(RobotList.name, request=request)
            })            
      
class RobotCategoryList(generics.ListCreateAPIView):
    queryset = RobotCategory.objects.all()
    serializer_class = RobotCategorySerializer
      
class RobotCategoryDetail(generics.RetrieveUpdateDestroyAPIView):
    queryset = RobotCategory.objects.all()
    serializer_class = RobotCategorySerializer
    name = 'robotcategory-detail'
  
class ManufacturerList(generics.ListCreateAPIView):
    queryset = Manufacturer.objects.all()
    serializer_class = ManufacturerSerializer
    name = 'manufacturer-list'
  
class ManufacturerDetail(generics.RetrieveUpdateDestroyAPIView):
    queryset = Manufacturer.objects.all()
    serializer_class = ManufacturerSerializer
    name = 'manufacturer-detail'        
  
class RobotList(generics.ListCreateAPIView):
    queryset = Robot.objects.all()
    serializer_class = RobotSerializer
    name = 'robot-list'
  
class RobotDetail(generics.RetrieveUpdateDestroyAPIView):
    queryset = Robot.objects.all()
    serializer_class = RobotSerializer
    name = 'robot-detail'

这里的RobotCategoryList、ManufacturerList和RobotList是generics.ListCreateAPIView的子类；RobotCategoryDetail、ManufacturerDetail和RobotDetail是generics.RetrieveUpdateDestroyAPIView的子类。每个子类有一个_queryset属性、serializer_class属性和一个name属性。queryset属性存储了所有被检索的对象，serializer_class属性存储了序列化器类，而name属性则用来识别每个视图。

除了基于类的视图，你可以注意到一个ApiRoot类，它是rest_framework.generics.GenericAPIView的一个子类。

class ApiRoot(generics.GenericAPIView):
    name = 'api-root'
    def get(self, request, *args, **kwargs):
        return Response({
            'robot-categories': reverse(RobotCategoryList.name, request=request),
            'manufacturers': reverse(ManufacturerList.name, request=request),
            'robots': reverse(RobotList.name, request=request)
            })

ApiRoot类为我们的RESTful网络服务的根创建了一个端点，以方便浏览资源集合。这个类中定义的获取方法会返回一个具有描述性名称和URL的响应对象。这里，它返回机器人类别列表、制造商列表和机器人列表的描述性名称和URL。

接下来，我们需要在正则表达式中指定URL模式，以运行views.py Python文件中定义的基于类的视图的特定方法。客户端HTTP请求必须与这个正则表达式相匹配，以运行views.py文件中的方法。你可以在restapi/robots中创建urls.py文件并添加以下代码。

from django.conf.urls import url
from robots import views
  
urlpatterns = [
    url(r'^robot-categories/ $', views.RobotCategoryList.as_view(), name=views.RobotCategoryList.name), url(r'^robot-categories/(?P<pk>[0-9]+)$ ',
        views.RobotCategoryDetail.as_view(),
        name=views.RobotCategoryDetail.name),
    
    url(r'^manufacturers/ $', views.ManufacturerList.as_view(), name=views.ManufacturerList.name), url(r'^manufacturers/(?P<pk>[0-9]+)$ ',
        views.ManufacturerDetail.as_view(),
        name=views.ManufacturerDetail.name),
    
    url(r'^robots/ $', views.RobotList.as_view(), name=views.RobotList.name), url(r'^robots/(?P<pk>[0-9]+)$ ',
        views.RobotDetail.as_view(),
        name=views.RobotDetail.name),
    
    url(r'^$',
        views.ApiRoot.as_view(),
        name=views.ApiRoot.name),
]

作为最后一步，我们需要定义根URL的配置。你可以打开restapi/restapi/urls.py Python文件，用下面的代码替换它。

from django.conf.urls import url, include
  
urlpatterns = [
    url(r'^', include('robots.urls')),
]

与资源互动的HTTP请求

现在是时候通过组成和发送各种HTTP请求来测试我们的代码了。在这里，我们将同时利用HTTPie命令和CURL命令。

创建一个新的机器人类别

让我们编写并发送一个HTTP Post请求来创建一个新的机器人类别。HTTPie的命令是。

http POST :8000/robot-categories/ name=”关节型机器人” notes=”灵活性、灵巧性和伸展性使关节型机器人非常适用于跨越非平行平面的任务”