Kas yra DRF viewsets ir routers?

Question

Accepted Answer

Django REST Framework **viewsets** sugrupuoja susijusių API galinių taškų (CRUD operacijas ištekliaus) logiką į vieną klasę, o **routers** automatiškai generuoja jų URL maršrutizavimą. Kartu jie dramatiškai sumažina standartinį kodą RESTful API kūrimui.

## ModelViewSet — pilnas CRUD keliais eilutėm

```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` automatiškai pateikia **pilną RESTful CRUD galinių taškų rinkinį** modeliui — sąrašą, kūrimą, paieškos rezultatų grąžinimą, atnaujinimą, dalinį atnaujinimą ir ištrynimą — iš tik queryset ir serializer. Nereikia kiekvieno view'o rašyti atskirai.

## Routers — automatinis URL generavimas

```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** automatiškai susieja viewset su pilnu standartinių RESTful URL rinkiniu — registruojant vieną viewset, generuojami visi konvenciniai galiniai taškai su tinkamais HTTP metodais, šalinant rankinį URL konfigūravimą.

## Viewsets pritaikymas

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

Viewsets pritaikomi perrašant metodus (`get_queryset`, `perform_create`), nustatant teises ir pridedant **pasirinktinus veiksmus** (`@action`) galiniais taškais už standartinio CRUD.

## Viewsets prieš generines API vaizdus

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

## Kodėl tai svarbu

Viewsets ir routers yra galinga DRF funkcija RESTful API efektyviam kūrimui — jie reiškia aukščiausią abstrakcijos lygį labai bendram modelio atidengimui kaip pilno REST ištekliaus atvejui, ir jų supratimas yra vertingas produktyviam API kūrimui.

Pagrindinė nauda — dramatiškas **standartinio kodo sumažėjimas**: `ModelViewSet` plius router suteikia pilną, konvencinę REST API ištekliui (visus CRUD galinį taškus su tinkamais HTTP metodais ir URL) iš tik queryset ir serializer — pakeičiant tai, kas kitaip būtų daug atskirų view'ų ir rankinių URL šablonų.

Tai padarytų standartinių REST API kūrimą nepaprastai greitą, tuo pat metu užtikrinant, kad **RESTful konvencijos** (nuoseklus URL struktūra ir HTTP metodo semantika) būtų laikomos automatiškai.

Viewsets lieka lanksčios — jūs jas pritaikote perrašydami metodus (filteruodami queryset pagal vartotoją, kontroliuodami teises, kabindamasi į create/update) ir pridedami **pasirinktinus veiksmus** (`@action`) galiniais taškais už pagrindinį CRUD.

Supratimas apie viewsets ir routers, kaip jie generuoja galinį taškus, kaip juos pritaikyti, ir **kada juos naudoti** (konvenciniai REST ištekliai) prieš aiškesnius generines vaizdus ar APIView (pasirinktiniai/nestandartiniai galiniai taškai) yra svarbi praktinė žinios DRF kūrimui.

Kadangi REST API kūrimas yra primarusis Django naudojimas šiandien, ir viewsets+routers yra idiomatinis, produktyviausias būdas tai daryti standartiniams ištekliams, jie yra dažnai naudojama, svarbi DRF įrankių dalis, kuri leidžia kūrėjams kurti tvirias API su minimaliu kodu, išlaikant lankstumo pasirinktiniams reikalavimams spręsti.