Browsable API<\/strong>: interfaccia HTML interattiva per esplorare e testare gli endpoint durante lo sviluppo.<\/li>\n<\/ul>\n\n\n\nHa un workflow abbastanza intuitivo diviso in serializers, views e routers:GenericAPIView<\/code>, ListAPIView<\/code>, CreateAPIView<\/code>, ecc.) per operazioni comuni. I ViewSet<\/code> aggregano pi\u00f9 azioni (list, create, retrieve, update, destroy) in un’unica classe, lavorando in sinergia con i Routers per ridurre ulteriormente il codice.DefaultRouter<\/code> si ottengono endpoint come \/notes\/<\/code> per list\/create e \/notes\/{pk}\/<\/code> per retrieve\/update\/delete, senza dover scrivere manualmente ogni URL.<\/p>\n\n\n\nPreparazione dell’ambiente<\/strong><\/h2>\n\n\n\nInstallazione<\/strong><\/h3>\n\n\n\nAssicurati di avere Django installato e poi aggiungi Django REST Framework:<\/p>\n\n\n
pip install djangorestframework<\/code><\/span><\/pre>\n\n\nAggiungilo alle app installate in settings.py:<\/p>\n\n\n
INSTALLED_APPS = [\n\n\u00a0\u00a0\u00a0\u00a0...\n\n\u00a0\u00a0\u00a0\u00a0'rest_framework'<\/span>,\n]<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\nCreazione del modello<\/strong><\/h2>\n\n\n\nDefiniamo un modello semplice per una nota:<\/p>\n\n\n
from django.db import models\n\nclass Note(models.Model):\n\u00a0\u00a0\u00a0\u00a0title = models.CharField(max_length=100)\n\u00a0\u00a0\u00a0\u00a0content = models.TextField()\n\u00a0\u00a0\u00a0\u00a0created_at = models.DateTimeField(auto_now_add=True)<\/code><\/span><\/pre>\n\n\nDopo aver definito il modello, applica le migrazioni:<\/p>\n\n\n
python<\/span> manage<\/span>.py<\/span> makemigrations<\/span>\n\npython<\/span> manage<\/span>.py<\/span> migrate<\/span><\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\nCreazione del Serializer<\/strong><\/h2>\n\n\n\nCreiamo un file all\u2019interno della directory della nostra app e lo chiamiamo serializers.py<\/code><\/p>\n\n\n\nI serializer convertono i dati del database in formato JSON:<\/p>\n\n\n
from rest_framework import serializers\nfrom .models import Note\n\nclass NoteSerializer(serializers.ModelSerializer):\n\n\u00a0\u00a0\u00a0\u00a0class Meta:\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0model = Note\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0fields = '__all__'<\/code><\/span><\/pre>\n\n\nCreazione della View<\/strong><\/h2>\n\n\n\nApriamo il file views.py<\/code>, cancelliamo tutto il codice al suo interno.<\/p>\n\n\n\nUsiamo una ListCreateAPIView<\/code>, che permette di ottenere la lista degli elementi (GET) e di crearne di nuovi (POST):<\/p>\n\n\nfrom rest_framework import generics\nfrom .models import Note\nfrom .serializers import NoteSerializer\n\nclass NoteListCreateView(generics.ListCreateAPIView):\n\u00a0\u00a0\u00a0\u00a0queryset = Note.objects.all()\n\u00a0\u00a0\u00a0\u00a0serializer_class = NoteSerializer<\/code><\/span><\/pre>\n\n\nConfigurazione degli URL<\/strong><\/h2>\n\n\n\nAggiungiamo un URL per la nostra API, quindi apriamo il file urls.py<\/code> all\u2019interno della nostra app:<\/p>\n\n\nfrom<\/span> django.urls import<\/span> path\nfrom<\/span> .views import<\/span> NoteListCreateView\n\nurlpatterns = [\n\u00a0\u00a0\u00a0\u00a0path('notes\/'<\/span>, NoteListCreateView.as_view(), name='note-list-create'<\/span>),\n]<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\nNel file urls.py<\/code> principale del progetto:<\/p>\n\n\nfrom<\/span> django.urls import<\/span> path, include\n\nurlpatterns = [\n\u00a0\u00a0\u00a0\u00a0path('api\/'<\/span>, include('nome_app.urls'<\/span>)),\n]<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\nLa Browsable API di Django REST Framework<\/strong><\/p>\n\n\n\nDjango REST Framework include una Browsable API<\/strong> integrata che permette di esplorare e interagire con i tuoi endpoint direttamente dal browser, senza dover ricorrere ad altri strumenti come Postman o curl. \u00c8 una vera interfaccia utente HTML dinamica che:<\/p>\n\n\n\n\nVisualizza le risorse<\/strong>: elenca i campi disponibili, i relativi tipi e i valori correnti, in modo chiaro e leggibile.Supporta le operazioni CRUD<\/strong>: fornisce automaticamente form per inviare richieste GET, POST, PUT e DELETE, compilando i campi in base al serializer.Gestisce l\u2019autenticazione<\/strong>: permette di autenticarsi via sessione o token direttamente dall\u2019interfaccia, nascondendo o mostrando i link a seconda dei permessi.Mostra gli errori<\/strong>: evidenzia gli errori di validazione con messaggi dettagliati accanto ai campi, facilitando il debug.Per abilitarla non serve alcuna configurazione aggiuntiva: basta includere ‘rest_framework’ in INSTALLED_APPS e accedere all\u2019URL nel browser (es. http:\/\/127.0.0.1:8000\/api\/notes\/). La Browsable API \u00e8 particolarmente utile in fase di sviluppo, perch\u00e9 consente di testare rapidamente gli endpoint, verificare il formato dei dati e comprendere la struttura delle risposte JSON in maniera visuale.
Testing dell’API<\/strong><\/h2>\n\n\n\nPossiamo testare il nostro endpoint con strumenti come curl<\/strong> o Postman<\/strong>, oppure utilizzando la browsable api inclusa in django rest framework.<\/p>\n\n\n\nQuindi apriamo il terminale e scriviamo:<\/p>\n\n\n
python<\/span> manage<\/span>.py<\/span> runserver<\/span><\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\nEsempio di richiesta GET:<\/strong><\/p>\n\n\ncurl http:
![\"\"\/](\"https:\/\/i.ibb.co\/yBh6BW5t\/Screenshot-2025-04-29-alle-11-52-17.png\")
<\/figure>\n\n\n\n![\"\"\/](\"https:\/\/i.ibb.co\/Pzj6D8Hc\/Screenshot-2025-04-29-alle-11-53-28.png\")
<\/figure>\n\n\n\n![\"\"\/](\"https:\/\/i.ibb.co\/8nnhb7BX\/Screenshot-2025-04-29-alle-11-58-35.png\")
<\/figure>\n\n\n\n![\"\"\/](\"https:\/\/i.ibb.co\/9mFCmhgM\/Screenshot-2025-04-29-alle-11-59-08.png\")
<\/figure>\n\n\n\n![\"\"\/](\"https:\/\/i.ibb.co\/gZX95SvH\/Screenshot-2025-04-29-alle-12-01-45.png\")
<\/figure>\n\n\n\n![\"\"\/](\"https:\/\/i.ibb.co\/kgHZMSCD\/Screenshot-2025-04-29-alle-12-02-14.png\")
<\/figure>\n\n\n\n