如何自定义Django REST Framework GET请求的响应?

时间:2016-08-22 15:27:59

标签: django django-rest-framework

我有一个模型Foo,我用它作为我的香草DRF序列化器的模型。

models.py

class Foo(models.Model):
    name = models.CharField(max_length=20)
    description = models.TextField()
    is_public = models.BooleanField(default=False)

serializers.py

class FooSerializer(serializers.ModelSerializer):
    class Meta:
        model = Foo

views.py

class FooRetrieveAPIView(RetrieveAPIView):
    queryset = Foo.objects.all()
    serializer_class = FooSerializer

现在,前端代码正在使用此端点的结果,这是确定下一页显示方式的基础。无论如何,我需要更改状态200(现有记录)和404(不存在的记录)返回的结果的结构。

实际结果(来自香草DRF):

$ curl localhost:8000/foo/1/  # existing record
{"id": 1, "name": "foo", "description": "foo description", is_public=false}

$ curl localhost:8000/foo/2/  # non-existent record
{"detail": "Not found."}

我希望结果如何:

$ curl localhost:8000/foo/1/
{"error": "", "foo": {"id": 1, "name": "foo", "description": "foo description", is_public=false}}

$ curl localhost:8000/foo/2/
{"error": "Some custom error message", "foo": null}

我主要使用vanilla DRF所以事情非常简单,所以这个响应结构的自定义对我来说有点新鲜。

使用的Django版本:1.9.9

使用的DRF版本:3.3.x

2 个答案:

答案 0 :(得分:2)

您可以在视图中重写retrieve方法,以便更新序列化程序响应数据

class FooRetrieveAPIView(RetrieveAPIView):
    queryset = Foo.objects.all()
    serializer_class = FooSerializer

    def retrieve(self, request, *args, **kwargs):
        instance = self.get_object()
        serializer = self.get_serializer(instance)
        data = serializer.data
        # here you can manipulate your data response
        return Response(data)

答案 1 :(得分:0)

我遇到了类似的问题,并且不想创建自定义异常处理程序,因为我希望能够更好地控制为api调用定义错误消息。 在进行了一些手动操作后,我使用viewset中的以下代码在使用partial_update更新记录时获取自定义错误消息。

 def partial_update(self, request, *args, **kwargs):
    partial = kwargs.pop('partial', False)
    try:
        instance = self.get_object()
        serializer = self.get_serializer(instance, data=request.data, partial=partial)
        serializer.is_valid(raise_exception=True)
        self.perform_update(serializer)
        headers = self.get_success_headers(serializer.data)
        response = {"status": "True", "message": "", "data": serializer.data}
        return Response(response, status=status.HTTP_201_CREATED, headers=headers)
    except exception.Http404:
        headers = ""
        response = {"status": "False", "message": "Details not found", "data": ""}
        return Response(response, status=status.HTTP_200_OK, headers=headers)