Criando uma resposta JSON usando Django e Python


451

Estou tentando converter um script de resposta Ajax do servidor em um Django HttpResponse, mas aparentemente não está funcionando.

Este é o script do lado do servidor:

/* 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.
        }
    }
}

E este é o código convertido

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))

Estou usando simplejson para codificar a lista Python (portanto, ele retornará uma matriz JSON). Ainda não consegui descobrir o problema. Mas acho que fiz algo errado sobre o 'eco'.


Você também pode usar o decorador de vistas irritante para o django @ajax_request.
Zopieux 13/04/2014

Respostas:


917

Normalmente, uso um dicionário, não uma lista para retornar o conteúdo JSON.

import json

from django.http import HttpResponse

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

Antes do Django 1.7, você retornaria assim:

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

Para o Django 1.7+, use JsonResponsecomo mostrado nesta resposta do SO da seguinte maneira:

from django.http import JsonResponse
return JsonResponse({'foo':'bar'})

4
Ele é o tipo MIME, não na lista que deve estar recebendo-lo em apuros. Enquanto a maioria do JSON é tipicamente um objeto ("dicionário") no nível superior, o JSON está perfeitamente satisfeito com uma matriz no nível superior.
Thanatos

6
Desculpe, não está claro o que escrevi, mas eu quis dizer apenas usar um dicionário porque é mais fácil / limpo ao serializá-lo para JSON.
Tom

'application / json' não é suportado corretamente em versões mais antigas do IE. Aqui está uma discussão sobre o problema github.com/blueimp/jQuery-File-Upload/issues/123
Victory

161

Novo no django 1.7

você poderia usar objetos JsonResponse .

dos documentos:

from django.http import JsonResponse
return JsonResponse({'foo':'bar'})

2
Uma desvantagem: é o padrão ensure_asciie ainda não encontrei uma maneira de substituí-lo. Criou uma nova pergunta para isso: stackoverflow.com/q/34798703/854477
int_ua

@int_ua: basta adicionar json_dumps_params={"ensure_ascii": False}(requer Django 1.9 ou mais recente)
Martijn Pieters

139

Eu uso isso, funciona bem.

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')

Alternativa:

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,
        )

No Django 1.7, os objetos JsonResponse foram adicionados à estrutura do Django, o que facilita ainda mais esta tarefa:

from django.http import JsonResponse
def some_view(request):
    return JsonResponse({"key": "value"})

1
O problema é que ele não está obtendo o valor do campo de entrada vld_value = request.POST.get ('validateValue')
Comute

2
Com Python 2.7, deve ser apenas "json importação"
Cullen Fluffy Jennings

1
Eu acho que from django.utils import simplejsoné para compatibilidade com versões anteriores.
Skylar Saveland

JsonResponse(status=404, data={'status':'false','message':message})
Belter

25

Desde o Django 1.7, você tem um JsonResponse padrão que é exatamente o que você precisa:

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

Você nem precisa json.dump sua matriz.


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)

E na visão:

resp_data = {'my_key': 'my value',}
return JsonResponse(resp_data)

15

Para quem usa o Django 1.7+

from django.http import JsonResponse

def your_view(request):
    json_object = {'key': "value"}
    return JsonResponse(json_object)

documentos oficiais


11

Você vai querer usar o serializador do django para ajudar com coisas unicode:

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")

2
Esta era minha versão preferida, mas percebi que ela consome apenas o Django QuerySets .
Patroqueeet

10

Com as visualizações baseadas na classe Django, você pode escrever:

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

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

e com o Django-Rest-Framework você pode escrever:

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

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

6

É muito conveniente com o Django versão 1.7 ou superior, pois você tem a classe JsonResponse, que é uma subclasse do HttpResponse.

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

Para versões mais antigas do Django, você deve usar um objeto 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')

6

Como usar o google app engine com ajax (json)?

Código Javascript com JQuery:

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

Code 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)

4

Esta é minha versão preferida usando uma exibição baseada em classe. Basta subclassificar a View básica e substituir o método get () -.

import json

class MyJsonView(View):

    def get(self, *args, **kwargs):
        resp = {'my_key': 'my value',}
        return HttpResponse(json.dumps(resp), mimetype="application/json" )

4

Código Django views.py:

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

Código 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

Primeiro importe isso:

from django.http import HttpResponse

Se você já possui o JSON:

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

Se você obtiver o JSON de outra solicitação HTTP:

def your_method(request):
    response = request.get('https://www.example.com/get/json')
    return HttpResponse(response, 'application/json')


1

No modo de exibição, use isto:

form.field.errors|striptags

para obter mensagens de validação sem html

Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.