Создание ответа JSON с использованием Django и Python

453

Я пытаюсь преобразовать серверный сценарий ответа Ajax в Django HttpResponse, но, видимо, он не работает.

Это серверный скрипт:

/* RECEIVE VALUE */
$validateValue=$_POST['validateValue'];
$validateId=$_POST['validateId'];
$validateError=$_POST['validateError'];

/* RETURN VALUE */
$arrayToJs = array();
$arrayToJs[0] = $validateId;
$arrayToJs[1] = $validateError;

if($validateValue =="Testuser"){  // Validate??
    $arrayToJs[2] = "true";       // RETURN TRUE
    echo '{"jsonValidateReturn":'.json_encode($arrayToJs).'}';  // RETURN ARRAY WITH success
}
else{
    for($x=0;$x<1000000;$x++){
        if($x == 990000){
            $arrayToJs[2] = "false";
            echo '{"jsonValidateReturn":'.json_encode($arrayToJs).'}';   // RETURNS ARRAY WITH ERROR.
        }
    }
}

И это преобразованный код

def validate_user(request):
    if request.method == 'POST':
        vld_value = request.POST.get('validateValue')
        vld_id = request.POST.get('validateId')
        vld_error = request.POST.get('validateError')

        array_to_js = [vld_id, vld_error, False]

        if vld_value == "TestUser":
            array_to_js[2] = True
            x = simplejson.dumps(array_to_js)
            return HttpResponse(x)
        else:
            array_to_js[2] = False
            x = simplejson.dumps(array_to_js)
            error = 'Error'
            return render_to_response('index.html',{'error':error},context_instance=RequestContext(request))
    return render_to_response('index.html',context_instance=RequestContext(request))

Я использую simplejson для кодирования списка Python (чтобы он возвращал массив JSON). Я еще не мог понять проблему. Но я думаю, что я сделал что-то не так с «эхо».

переключатель
источник
Вы также можете использовать django-раздражающий декоратор вида @ajax_request.
zopieux

Ответы:

918

Я обычно использую словарь, а не список для возврата содержимого JSON.

import json

from django.http import HttpResponse

response_data = {}
response_data['result'] = 'error'
response_data['message'] = 'Some error message'

Pre-Django 1.7 вы бы вернули его так:

return HttpResponse(json.dumps(response_data), content_type="application/json")

Для Django 1.7+ используйте JsonResponseкак показано в этом SO ответе так:

from django.http import JsonResponse
return JsonResponse({'foo':'bar'})
Том
источник
4
Это является MimeType, а не список , который должен получать его в неприятности. Хотя большинство JSON обычно являются объектами («словарями») на верхнем уровне, JSON вполне доволен массивом на верхнем уровне.
Танатос
6
Извините, это не ясно из того, что я написал, но я имел в виду только то, что я использую словарь, потому что он чище / проще при сериализации его в JSON.
Том
'application / json' не поддерживается должным образом в старых версиях IE. Вот небольшое обсуждение проблемы github.com/blueimp/jQuery-File-Upload/issues/123
Победа
162

Новое в Джанго 1,7

Вы можете использовать объекты JsonResponse .

из документов:

from django.http import JsonResponse
return JsonResponse({'foo':'bar'})
SRJ
источник
2
Один недостаток: по умолчанию, ensure_asciiи я еще не нашел способ переопределить его. Создан новый вопрос для этого: stackoverflow.com/q/34798703/854477
int_ua
@int_ua: просто добавьте json_dumps_params={"ensure_ascii": False}(требуется Django 1.9 или новее)
Martijn Pieters
140

Я использую это, он отлично работает.

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

def some_view(request):
    to_json = {
        "key1": "value1",
        "key2": "value2"
    }
    return HttpResponse(simplejson.dumps(to_json), mimetype='application/json')

Альтернатива:

from django.utils import simplejson

class JsonResponse(HttpResponse):
    """
        JSON response
    """
    def __init__(self, content, mimetype='application/json', status=None, content_type=None):
        super(JsonResponse, self).__init__(
            content=simplejson.dumps(content),
            mimetype=mimetype,
            status=status,
            content_type=content_type,
        )

В Django 1.7 объекты JsonResponse были добавлены в сам фреймворк Django, что делает эту задачу еще проще:

from django.http import JsonResponse
def some_view(request):
    return JsonResponse({"key": "value"})
Динго
источник
1
Проблема здесь в том, что он не получает значение из поля ввода vld_value = request.POST.get ('validateValue')
Switch
2
В python 2.7 это должен быть просто «import json»
Каллен Пушистый Дженнингс
1
Я думаю from django.utils import simplejsonдля обратной совместимости.
Skylar Saveland
JsonResponse(status=404, data={'status':'false','message':message})
Belter
25

Начиная с Django 1.7 у вас есть стандартный JsonResponse, который именно то, что вам нужно:

from django.http import JsonResponse
...
return JsonResponse(array_to_js, safe=False)

Вам даже не нужно json.dump вашего массива.

Akhorus
источник
16
from django.http import HttpResponse
import json

class JsonResponse(HttpResponse):
    def __init__(self, content={}, mimetype=None, status=None,
             content_type='application/json'):
        super(JsonResponse, self).__init__(json.dumps(content), mimetype=mimetype,
                                           status=status, content_type=content_type)

И в представлении:

resp_data = {'my_key': 'my value',}
return JsonResponse(resp_data)
Дмитрий Демиденко
источник
11

Вы захотите использовать сериализатор django для помощи с юникодом:

from django.core import serializers

json_serializer = serializers.get_serializer("json")()
    response =  json_serializer.serialize(list, ensure_ascii=False, indent=2, use_natural_keys=True)
    return HttpResponse(response, mimetype="application/json")
ReduxDJ
источник
2
Это была моя любимая версия, но понял, что она ест только Django QuerySets .
patroqueeet
10

С помощью представлений на основе классов Django вы можете написать:

from django.views import View
from django.http import JsonResponse

class JsonView(View):
    def get(self, request):
        return JsonResponse({'some': 'data'})

а с Django-Rest-Framework вы можете написать:

from rest_framework.views import APIView
from rest_framework.response import Response

class JsonView(APIView):
    def get(self, request):
        return Response({'some': 'data'})
элим
источник
6

Это очень удобно для Django версии 1.7 или выше, поскольку у вас есть класс JsonResponse, который является подклассом HttpResponse.

from django.http import JsonResponse
    def profile(request):
        data = {
            'name': 'Raghav',
            'location': 'India',
            'is_active': False,
            'count': 28
        }
        return JsonResponse(data)

Для более старых версий Django вы должны использовать объект HttpResponse.

import json
from django.http import HttpResponse

def profile(request):
    data = {
        'name': 'Raghav',
        'location': 'India',
        'is_active': False,
        'count': 28
    }
    dump = json.dumps(data)
    return HttpResponse(dump, content_type='application/json')
Tanmay D
источник
6

Как использовать Google App Engine с AJAX (JSON)?

Код Javascript с помощью JQuery:

$.ajax({
    url: '/ajax',
    dataType : 'json',
    cache: false,
    success: function(data) {
        alert('Load was performed.'+data.ajax_resp);
    }
});

Код Python

class Ajax(webapp2.RequestHandler):
    def get(self):
        my_response = {'ajax_resp':'Hello, webapp World!'}
        datos = json.dumps(my_response)

        self.response.headers.add_header('content-type', 'application/json', charset='utf-8')
        self.response.out.write(datos)
Samiro
источник
4

Это моя предпочтительная версия, использующая представление на основе классов. Просто создайте подкласс базового View и переопределите метод get ().

import json

class MyJsonView(View):

    def get(self, *args, **kwargs):
        resp = {'my_key': 'my value',}
        return HttpResponse(json.dumps(resp), mimetype="application/json" )
droidballoon
источник
4

Код Джанго views.py:

def view(request):
    if request.method == 'POST':
        print request.body
        data = request.body
        return HttpResponse(json.dumps(data))

HTML код view.html:

<!DOCTYPE html>
<html>
<head>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<script>
$(document).ready(function(){
    $("#mySelect").change(function(){
        selected = $("#mySelect option:selected").text()
        $.ajax({
            type: 'POST',
            dataType: 'json',
            contentType: 'application/json; charset=utf-8',
            url: '/view/',
            data: {
                    'fruit': selected
                  },
            success: function(result) {
                        document.write(result)
                    }
    });
  });
});
</script>
</head>
<body>

<form>
    {{data}}
    <br>
Select your favorite fruit:
<select id="mySelect">
  <option value="apple" selected >Select fruit</option>
  <option value="apple">Apple</option>
  <option value="orange">Orange</option>
  <option value="pineapple">Pineapple</option>
  <option value="banana">Banana</option>
</select>
</form>
</body>
</html>
Раджан Манданка
источник
4

Сначала импортируйте это:

from django.http import HttpResponse

Если у вас уже есть JSON:

def your_method(request):
    your_json = [{'key1': value, 'key2': value}]
    return HttpResponse(your_json, 'application/json')

Если вы получаете JSON из другого HTTP-запроса:

def your_method(request):
    response = request.get('https://www.example.com/get/json')
    return HttpResponse(response, 'application/json')
Сактивел Картикеян
источник
2

Используйте JsonResponse

from django.http import JsonResponse
Сурадж Верма
источник
Этот ответ нуждается в контексте и объяснении.
theUtherSide
1

В представлении использовать это:

form.field.errors|striptags

для получения проверочных сообщений без HTML

Дипак Шарма
источник