Apa itu viewsets dan routers DRF?

Question

Accepted Answer

In Django REST Framework, **viewsets** group the logic for a set of related API endpoints (the CRUD operations for a resource) into a single class, and **routers** automatically generate the URL routing for them. Together they dramatically reduce boilerplate for building RESTful APIs.

## ModelViewSet — CRUD lengkap dalam beberapa baris

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

A `ModelViewSet` automatically provides the **complete set of RESTful CRUD endpoints** for a model — list, create, retrieve, update, partial update, and delete — from just a queryset and serializer. No need to write each view separately.

## Routers — automatic URL generation

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

A **router** maps a viewset to a full set of standard RESTful URLs automatically — registering one viewset generates all the conventional endpoints with correct HTTP methods, eliminating manual URL configuration.

## Customizing viewsets

```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 are customized by overriding methods (`get_queryset`, `perform_create`), setting permissions, and adding **custom actions** (`@action`) for endpoints beyond standard CRUD.

## Viewsets vs generic 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.
```

## Mengapa ini penting

Viewsets dan routers adalah fitur powerful DRF untuk membangun API RESTful secara efisien — mereka mewakili tingkat abstraksi tertinggi untuk kasus yang sangat umum dari mengekspos model sebagai sumber daya REST penuh, dan memahaminya sangat berharga untuk pengembangan API yang produktif.

Manfaat utamanya adalah pengurangan **boilerplate** yang dramatis: `ModelViewSet` ditambah router memberikan API REST lengkap dan konvensional untuk sumber daya (semua endpoint CRUD dengan metode HTTP dan URL yang benar) hanya dari queryset dan serializer — menggantikan apa yang seharusnya menjadi banyak view terpisah dan pola URL manual.

Ini membuat membangun API REST standar secara luar biasa cepat sambil memastikan **konvensi RESTful** (struktur URL konsisten dan semantik metode HTTP) diikuti secara otomatis.

Viewsets tetap fleksibel — Anda menyesuaikannya dengan mengganti metode (`get_queryset`, `perform_create`), menetapkan izin, dan menambahkan **tindakan khusus** (`@action`) untuk endpoint di luar CRUD standar.

Memahami viewsets dan routers, cara mereka menghasilkan endpoint, cara menyesuaikannya, dan **kapan menggunakannya** (sumber daya REST konvensional) versus view generik yang lebih eksplisit atau APIView (endpoint khusus/non-standar) — adalah pengetahuan praktis penting untuk pengembangan DRF.

Karena membangun API REST adalah penggunaan utama Django saat ini, dan viewsets+routers adalah cara idiomatik dan paling produktif untuk melakukannya bagi sumber daya standar, mereka adalah bagian yang sering digunakan dan penting dari toolkit DRF yang memungkinkan pengembang membangun API yang robust dengan kode minimal sambil mempertahankan fleksibilitas untuk menangani persyaratan khusus.