Mitä ovat DRF viewset-sarjat ja reitittimet?

Question

Accepted Answer

Django REST Framework -kehyksessä **viewset-sarjat** ryhmittelevät joukon toisiinsa liittyviä API-päätepisteisiin liittyvän logiikan (resurssin CRUD-operaatiot) yhteen luokkaan, ja **reitittimet** luovat automaattisesti URL-reitityksen niille. Yhdessä ne vähentävät merkittävästi RESTful-sovellusliittymien rakentamiseen liittyvää koodin duplikointia.

## ModelViewSet — täydellinen CRUD muutamalla rivillä

```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` tarjoaa automaattisesti **täydellisen joukon RESTful CRUD -päätepisteistä** mallille — list, create, retrieve, update, partial update ja delete — pelkästään kyselysarjasta ja serialisaattorista. Jokaisen näkymän kirjoittaminen erikseen ei ole tarpeen.

## Reitittimet — automaattinen URL-generointi

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

**Reititin** kartoittaa viewset-sarjan täydelliseksi joukoksi vakiomuotoisia RESTful-URL-osoitteita automaattisesti — yhden viewset-sarjan rekisteröinti luo kaikki tavanomaiset päätepisteet oikeilla HTTP-metodeilla, mikä eliminoi manuaalisen URL-konfiguroinnin tarpeen.

## Viewset-sarjojen mukauttaminen

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

Viewset-sarjoja mukautetaan korvaamalla metodeja (`get_queryset`, `perform_create`), asettamalla käyttöoikeudet ja lisäämällä **mukautettuja toimintoja** (`@action`) vakio-CRUD:n ulkopuolisille päätepisteille.

## Viewset-sarjat vs generiset API-näkymät

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

## Miksi se on tärkeää

Viewset-sarjat ja reitittimet ovat tehokas DRF-ominaisuus RESTful-sovellusliittymien rakentamiseen tehokkaasti — ne edustavat abstraktiotasoa, joka on korkein äärimmäisen yleisen tapauksen kannalta, jossa mallia paljastetaan täytenä REST-resurssina, ja niiden ymmärtäminen on arvokasta tuottavalle sovellusliittymien kehittämiselle.

Pääetu on dramaattinen **koodin duplikaation vähentäminen**: `ModelViewSet` ja reititin antavat sinulle täydellisen, perinteisen REST-sovellusliittymän resurssille (kaikki CRUD-päätepisteet oikeilla HTTP-metodeilla ja URL-osoitteilla) pelkästään kyselysarjasta ja serialisaattorista — korvaten sen, mikä muuten olisi monia erillisiä näkymiä ja manuaalisia URL-kuvioita.

Tämä tekee vakio-REST-sovellusliittymien rakentamisesta huomattavan nopeaa ja samalla varmistetaan, että **RESTful-konventiot** (johdonmukainen URL-rakenne ja HTTP-metodien semantiikka) noudatetaan automaattisesti.

Viewset-sarjat pysyvät joustavina — mukauttamalla niitä korvaamalla metodeja (kyselysarjan suodattaminen käyttäjäkohtaisesti, käyttöoikeuksien hallinta, hookit luontiin/päivitykseen) ja lisäämällä **mukautettuja toimintoja** (`@action`) vakio-CRUD:n ulkopuolisille päätepisteille.

Viewset-sarjojen ja reitittimien ymmärtäminen, kuinka ne luovat päätepisteita, kuinka niitä mukautetaan, ja **milloin niitä käytetään** (tavanomaiset REST-resurssit) verrattuna eksplisiittisempiin geneerisiin näkymiin tai APIView-näkymiin (mukautetut/epämuodolliset päätepisteet) on tärkeä käytännön tieto DRF-kehitykselle.

Koska REST-sovellusliittymien rakentaminen on nykyään Djangon ensisijainen käyttötapaus, ja viewset-sarjat + reitittimet ovat idiomatiikan mukainen, tuottavin tapa tehdä se vakio-resursseille, ne ovat usein käytettävä, tärkeä osa DRF-työkalupakin, joka mahdollistaa kehittäjille robustien sovellusliittymien rakentamisen minimaalisen koodin avulla samalla kun säilytetään joustavuus mukautettujen vaatimusten käsittelemiseksi.