HOWTO · Django
Crea una risposta JSON in Django
Scopri come creare una risposta JSON in Django.
In questa pagina
Usa JsonResponse di Django per restituire da una vista dati serializzabili in JSON. Per impostazione predefinita accetta un dizionario; puoi passare una lista con safe=False. Per le istanze di modello o un QuerySet, scegli prima i campi da esporre nell’API e definiscine la struttura. Gli esempi seguenti illustrano viste basate su funzioni e su classi, risposte con liste, conversione dei modelli e l’alternativa di livello più basso con HttpResponse.
Restituire un oggetto JSON con JsonResponse di Django
Un dizionario è il dato più comune da passare a JsonResponse. Django lo serializza e imposta il tipo di contenuto della risposta su JSON, quindi una vista può restituirlo direttamente. Ecco una semplice struttura di dati utilizzabile con entrambi gli stili di vista:
Esegui questo esempio:
Il codice e le etichette o gli output visibili in questa sezione restano in inglese.
import json
data = {"name": "Ada", "active": True}
print(json.dumps(data, separators=(",", ":")))
Risultato:
{"name":"Ada","active":true}
Importa JsonResponse da django.http. Una vista basata su funzione può essere definita così: def profile(request): return JsonResponse({"name": "Ada", "active": True}). Per una vista basata su classe, importa anche View da django.views e definisci class ProfileView(View): get = lambda self, request: JsonResponse({"name": "Ada", "active": True}). Questi schemi di vista specifici di Django richiedono un progetto configurato; l’esempio basato sulla libreria standard mostra la struttura dei dati JSON, non una richiesta o una risposta Django.
L’impostazione predefinita con dizionario è utile perché favorisce una struttura di risposta con chiavi esplicite ed estensibile. Per esempio, oggi un’API può restituire {"name": "Ada", "active": True} e in seguito aggiungere un’altra chiave senza cambiare il tipo del valore al livello principale. Assicurati che i valori siano serializzabili in JSON: stringhe, numeri, valori booleani, None, liste e dizionari sono scelte comuni.
Restituire un array JSON con JsonResponse
Anche una lista è un valore JSON valido, ma JsonResponse si aspetta un dizionario, a meno che non venga configurato diversamente. Imposta safe=False quando il valore al livello principale è una lista:
return JsonResponse(["Django", "Python"], safe=False)
Usa questa forma quando la risposta è essa stessa una raccolta. Se i client hanno bisogno di metadati, come il conteggio degli elementi o i dettagli della paginazione, restituisci invece un dizionario che contenga la lista, per esempio {"items": ["Django", "Python"], "count": 2}. safe=False consente una struttura diversa al livello principale; non rende serializzabili oggetti Python arbitrari.
Convertire i dati di modelli e QuerySet prima di restituire JSON
Un’istanza di un modello Django e un QuerySet non sono serializzabili automaticamente in JSON. Scegli i campi da includere nella risposta pubblica e converti ogni record in valori Python comuni prima di passare il risultato a JsonResponse. In questo modo eviti anche di esporre per errore campi interni del modello.
Per esempio, una vista può recuperare un oggetto Blog e più blog, quindi definirne esplicitamente la struttura:
one = Blog.objects.get(pk=1)
many = Blog.objects.all()
one_data = {"title": one.title, "likes": one.likes}
many_data = [{"title": blog.title, "likes": blog.likes} for blog in many]
return JsonResponse({"blog": one_data, "blogs": many_data})
È uno schema essenziale per preparare i dati, non una vista completa: presuppone che il modello Blog e il relativo database siano configurati. Se serve un’immagine, una data, un oggetto correlato o un altro campo non primitivo, convertilo deliberatamente in una stringa, un numero, un valore booleano, una lista o un dizionario che rappresenti il contratto dell’API. Per esigenze di serializzazione più ampie o complesse, puoi ricorrere anche ai serializer di Django; consulta la documentazione sulla serializzazione di Django.
Creare JSON manualmente con HttpResponse
Usa HttpResponse quando vuoi controllare direttamente la fase di serializzazione. Importa sia json sia HttpResponse, codifica un valore Python compatibile con JSON usando json.dumps e imposta content_type su application/json:
import json
from django.http import HttpResponse
return HttpResponse(json.dumps({"name": "Ada"}), content_type="application/json")
Questo approccio di livello più basso produce una risposta JSON se il valore fornito può essere codificato. Per i normali dizionari e le liste, JsonResponse è in genere più chiaro, perché gestisce la codifica JSON e il tipo di contenuto. Come con JsonResponse, converti prima le istanze di modello e i risultati di QuerySet in una struttura esplicita compatibile con JSON.