来自视图的标准化 JSON 响应

Question

当我的页面将表单发布到我的 Django 视图时，该视图返回包含一些数据的响应，但很快我就遇到了我的视图以不同格式和不同信息集返回数据的问题。我考虑过使用 JSON 作为标准格式来返回我的数据。

有两种类型的状态：成功和失败。当 POST 成功时，它只返回 success 但当失败时，它会返回一个名为 errors 的子组，其中包含一个字段和该字段的错误。

这是一个失败响应示例：

{"failure": {
    "errors":[
        {"fieldname": "<fieldname>", 
         "fielderror": "<fielderror>"
        },
        {"fieldname": "<fieldname>", 
         "fielderror": "<fielderror>"
        }]
}}

这是一个成功响应示例：（

{"success": {
    "data":[
        {"fieldname": "<fieldname>", 
         "fielddata": "<fielddata>"
        },
        {"fieldname": "<fieldname>", 
         "fielddata": "<fielddata>"
        }]
}}

成功响应具有数据字段，因为您经常希望返回一些数据，即新创建的数据库记录的键。 ）

这就是我想出的，但是有很多人使用 Django，我想知道是否有一个标准的方法/更强大的方法或一些模块来帮助解决这个问题。

谢谢。

Answer 1

去过那里。我自己编写了解决方案（因为它很简单。我不知道是否有一个模块可以解决这个问题）。这只是一个 json 响应包装器

from django.utils import simplejson
from django.http import HttpResponse

class JsonResponse(HttpResponse):
    def __init__(self, data):
        content = simplejson.dumps(data)
        super(JsonResponse, self).__init__(content=content,
                                           mimetype='application/json')

class Success(JsonResponse):
    def __init__(self, something):
        x = something # set your data here
        content = {'success': {'data': x}}
        super(Success, self).__init__(content)


class Failure(JsonResponse):
    def __init__(self, something):
        x = something # set your data
        content = {'failures': {'errors': x}}
        super(Failure, self).__init__(content)

之类的东西。就我而言，我使 Success 和 Failure 接受字符串和字典作为参数（例如 Success(data)），以使其更加容易

如果您的结构非常复杂（或者您太懒而无法手动编写它们），请为该复杂结构编写您自己的包装器（这样您就可以用更少的打字创建响应），并使成功/失败接受它作为参数。

Answer 2

你知道如何使用Python字典吗？如果是这样，那么有一些库可以将 Python 字典转换为有效的 JSON。例如，Django 的内置是 simplejson。这里有一个例子：

from django.utils import simplejson

def my_view(request):
   ....
   my_json = simplejson.dumps(my_dict) #dumps a JSON string from a dict
   my_dict_again = simplejson.loads(my_json) #loads a Python dict from a JSON string

   return HttpResponse(json, mimetype="application/json")

Answer 3

好吧，我不知道这对你有多大帮助，但 Python 确实有一个模块 json。

>>> import json
>>> json.dumps({'a':'b', 'c':'d'})
'{"a": "b", "c": "d"}'

Answer 4

我认为前端将会为你应该如何格式化你的数据提供一个更有力的案例，然后是一些“标准”，不同的客户端框架期望不同的东西，并更好或更差地适应与期望的差异。

我试图让自己的生活更轻松的一种方法是让响应的“形状”始终大致相同，例如，响应将始终具有“状态”属性，该属性始终具有“错误”属性，并且如果没有错误，则 result.status.errors 的值为 null。如果出现错误，它将是一个字符串列表，解释出了什么问题。即使出现错误，也会有一个“value”属性，如果无法处理请求，则该属性将为 null；如果可以，则为请求的资源。