Czym są viewsety i routery w DRF?

Question

Accepted Answer

W Django REST Framework **viewsety** grupują logikę dla zestawu powiązanych endpointów API (operacje CRUD dla zasobu) w jedną klasę, a **routery** automatycznie generują dla nich routing URL. Razem dramatycznie redukują boilerplate przy budowaniu RESTful API.

## ModelViewSet — pełne CRUD w kilka linii

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

`ModelViewSet` automatycznie dostarcza **kompletny zestaw RESTful endpointów CRUD** dla modelu — list, create, retrieve, update, partial update i delete — z samego queryset i serializera. Nie trzeba pisać każdego view osobno.

## Routery — automatyczne generowanie 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
```

**Router** mapuje viewset na pełny zestaw standardowych RESTful URL automatycznie — rejestracja jednego viewsetu generuje wszystkie konwencjonalne endpointy z poprawnymi HTTP metodami, eliminując ręczną konfigurację URL.

## Dostosowywanie viewsetów

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

Viewsety są dostosowywane przez przesłanianie metod (`get_queryset`, `perform_create`), ustawianie uprawnień i dodawanie **niestandardowych akcji** (`@action`) dla endpointów poza standardowym CRUD.

## Viewsety vs generyczne API views

```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.
```

## Dlaczego to ważne

Viewsety i routery to potężna funkcja DRF do wydajnego budowania RESTful API — reprezentują najwyższy poziom abstrakcji dla niezwykle częstego przypadku, jakim jest udostępnianie modelu jako pełnego zasobu REST, a ich zrozumienie jest cenne dla produktywnego tworzenia API.

Kluczową korzyścią jest dramatyczne **zmniejszenie boilerplate**: `ModelViewSet` plus router daje ci kompletne, konwencjonalne REST API dla zasobu (wszystkie endpointy CRUD z poprawnymi HTTP metodami i URL) z samego queryset i serializera — zastępując to, co w innym razie byłoby wieloma oddzielnymi views i ręcznym konfigurowaniem wzorców URL.

To sprawia, że budowanie standardowych REST API jest niezwykle szybkie, jednocześnie zapewniając automatyczne przestrzeganie **konwencji RESTful** (spjna struktura URL i semantyka HTTP metod).

Viewsety pozostają elastyczne — dostosowujesz je przez przesłanianie metod (filtrowanie queryset na podstawie użytkownika, kontrolowanie uprawnień, podłączanie się do create/update) i dodawanie **niestandardowych akcji** (`@action`) dla endpointów poza podstawowym CRUD.

Zrozumienie viewsetów i routerów, jak generują endpointy, jak je dostosować i **kiedy ich używać** (konwencjonalne zasoby REST) w porównaniu z bardziej jawnymi generycznymi views lub APIView (niestandardowe/niekonwencjonalne endpointy) to ważna praktyczna wiedza dla tworzenia aplikacji DRF.

Ponieważ budowanie REST API jest głównym zastosowaniem Django dzisiaj, a viewsety+routery to idiomatyczny, najbardziej produktywny sposób robienia tego dla standardowych zasobów, są one często używaną, ważną częścią zestawu narzędzi DRF, która pozwala deweloperom budować niezawodne API z minimalną ilością kodu, zachowując elastyczność do obsługi niestandardowych wymagań.