时间戳

首页 > 解决方案 > 修改Djangorestframework响应结构

django-rest-framework - 修改Djangorestframework响应结构

问题描述

我遇到了这样一种情况，我的前端人员需要来自我所有端点的以下格式的响应。

{ status: 200, message: "OK", content: {Normal DRF Response Body} }

我知道我可以通过在所有视图中使用 APIView 来获得这种结构，但是我将无法使用通用视图或视图集。

我在想是否有任何方法可以扩展 DRF 响应类并在 settings.py 中指定扩展类，或者为此目的使用中间件。

为此可以做些什么？

标签： django-rest-frameworkdjango-request

解决方案

就在这里。

您可以像这样实现您的渲染器并将其添加到您的 settings.py 中：

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': (
        '< your renderer >',       
    ),  
}

对于实际的渲染器 - 从 rest_framework 的 JSON 渲染器 (rest_framework.renderers.JSONRenderer) 中获取灵感。

您基本上可以实现这个 JSONRenderer 并稍微更改渲染功能。

  def render(self, data, accepted_media_type=None, renderer_context=None):
    """
    Render `data` into JSON, returning a bytestring.
    """

在这里，您将可以访问数据和 renderer_context。上下文具有响应对象，即您的响应。它具有您可以在响应中使用的“status_code”属性。

response = renderer_context['response']
my_response = { "status" : response.status_code,
                "message" : "OK",
                "content" : data }

对于消息，您可以在哪里获得给定状态代码的正确消息。

然后，如果您遵循原始 JSONRendener 实现，您可以找到以下代码段，您可以更改它以转储您的新响应：

ret = json.dumps(
        my_response, cls=self.encoder_class,
        indent=indent, ensure_ascii=self.ensure_ascii,
        allow_nan=not self.strict, separators=separators
    )

推荐阅读