Cosa sono i viewset e i router di DRF?

Question

Accepted Answer

In Django REST Framework, i **viewset** raggruppano la logica per un insieme di endpoint API correlati (le operazioni CRUD per una risorsa) in un'unica classe, e i **router** generano automaticamente il routing degli URL per essi. Insieme riducono drasticamente il boilerplate per la costruzione di API RESTful.

## ModelViewSet — CRUD completo in poche righe

```python
from rest_framework import viewsets

class ArticleViewSet(viewsets.ModelViewSet):
    queryset = Article.objects.all()             # the data
    serializer_class = ArticleSerializer          # how to serialize it
    # That's it! This provides ALL standard CRUD endpoints automatically:
    #   list (GET), create (POST), retrieve (GET /id), update (PUT/PATCH /id), destroy (DELETE /id)
```

Un `ModelViewSet` fornisce automaticamente l'**insieme completo di endpoint CRUD RESTful** per un modello — list, create, retrieve, update, partial update e delete — da solo un queryset e un serializer. Non è necessario scrivere ogni view separatamente.

## Router — generazione automatica degli URL

```python
from rest_framework.routers import DefaultRouter

router = DefaultRouter()
router.register(r"articles", ArticleViewSet)     # register the viewset

urlpatterns = router.urls
# automatically creates the RESTful URLs:
#   GET    /articles/        → list
#   POST   /articles/        → create
#   GET    /articles/{id}/   → retrieve
#   PUT    /articles/{id}/   → update
#   PATCH  /articles/{id}/   → partial update
#   DELETE /articles/{id}/   → destroy
```

Un **router** associa un viewset a un set completo di URL RESTful standard automaticamente — registrare un viewset genera tutti gli endpoint convenzionali con i metodi HTTP corretti, eliminando la configurazione manuale degli URL.

## Personalizzazione dei viewset

```python
class ArticleViewSet(viewsets.ModelViewSet):
    serializer_class = ArticleSerializer
    permission_classes = [IsAuthenticated]        # authorization

def get_queryset(self):                        # customize the data per request
        return Article.objects.filter(author=self.request.user)

# add CUSTOM endpoints beyond CRUD with @action
    @action(detail=True, methods=["post"])
    def publish(self, request, pk=None):           # POST /articles/{id}/publish/
        article = self.get_object()
        article.published = True
        article.save()
        return Response({"status": "published"})
```

I viewset vengono personalizzati sovrascrivendo i metodi (`get_queryset`, `perform_create`), impostando le autorizzazioni e aggiungendo **azioni personalizzate** (`@action`) per endpoint al di là dello CRUD standard.

## Viewset vs API generic view

```text
ModelViewSet  → ALL CRUD in one class + router → least code for standard REST resources
Generic views (ListCreateAPIView, etc.) → more explicit, one class per endpoint group
APIView       → full manual control for non-standard/custom endpoints
→ Use viewsets+routers for conventional REST resources; generic/APIView for custom needs.
```

## Perché è importante

I viewset e i router sono una potente funzionalità di DRF per costruire API RESTful in modo efficiente — rappresentano il livello più elevato di astrazione per il caso estremamente comune di esporre un modello come risorsa REST completa, e comprenderli è prezioso per lo sviluppo di API produttive.

Il vantaggio principale è la drastica **riduzione del boilerplate**: un `ModelViewSet` più un router ti fornisce un'API REST completa e convenzionale per una risorsa (tutti gli endpoint CRUD con i metodi HTTP e gli URL corretti) da solo un queryset e un serializer — sostituendo quello che altrimenti sarebbero molte view separate e pattern di URL manuali.

Questo rende la costruzione di API REST standard straordinariamente veloce garantendo che le **convenzioni RESTful** (struttura URL coerente e semantica dei metodi HTTP) siano seguite automaticamente.

I viewset rimangono flessibili — li personalizzi sovrascrivendo i metodi (filtrando il queryset per utente, controllando le autorizzazioni, agganciando create/update) e aggiungendo **azioni personalizzate** (`@action`) per endpoint al di là del CRUD di base.

Capire i viewset e i router, come generano gli endpoint, come personalizzarli, e **quando usarli** (risorse REST convenzionali) rispetto a view generiche più esplicite o APIView (endpoint personalizzati/non standard) è una conoscenza pratica importante per lo sviluppo con DRF.

Poiché la costruzione di API REST è un uso principale di Django oggi, e viewset+router sono il modo idiomatico e più produttivo per farlo con risorse standard, sono una parte frequentemente utilizzata e importante del toolkit di DRF che permette agli sviluppatori di costruire API robuste con codice minimo mantenendo la flessibilità per gestire requisiti personalizzati.