Apakah viewset dan router DRF?

Question

Accepted Answer

Dalam Django REST Framework, **viewset** mengelompokkan logik untuk satu set titik akhir API berkaitan (operasi CRUD untuk sumber) ke dalam satu kelas, dan **router** secara automatik menjana penghalaan URL untuknya. Bersama-sama ia mengurangkan boilerplate secara dramatik untuk membina API RESTful.

## ModelViewSet — CRUD penuh 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)
```

Satu `ModelViewSet` secara automatik menyediakan **set lengkap titik akhir CRUD RESTful** untuk sesuatu model — senaraikan, cipta, dapatkan, kemas kini, kemas kini separa, dan padam — hanya daripada satu queryset dan serializer. Tidak perlu menulis setiap view secara berasingan.

## Router — penjanaan URL automatik

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

Satu **router** memetakan viewset kepada satu set lengkap URL RESTful standard secara automatik — mendaftarkan satu viewset menjana semua titik akhir konvensional dengan kaedah HTTP yang betul, menghapuskan konfigurasi URL manual.

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

Viewset disesuaikan dengan menggantikan kaedah (`get_queryset`, `perform_create`), menetapkan kebenaran, dan menambah **tindakan tersuai** (`@action`) untuk titik akhir di luar CRUD standard.

## Viewset berbanding generic API 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.
```

## Mengapa ia penting

Viewset dan router ialah ciri DRF yang berkuasa untuk membina REST API dengan cekap — ia mewakili tahap abstraksi tertinggi untuk kes yang amat biasa iaitu mendedahkan model sebagai sumber REST penuh, dan memahaminya bernilai untuk pembangunan API yang produktif.

Manfaat utamanya ialah **pengurangan boilerplate** yang dramatik: satu `ModelViewSet` ditambah satu router memberi anda REST API yang lengkap dan konvensional untuk sumber (semua titik akhir CRUD dengan kaedah HTTP dan URL yang betul) hanya daripada satu queryset dan serializer — menggantikan apa yang sebaliknya akan menjadi banyak view berasingan dan corak URL manual.

Ini menjadikan pembinaan REST API standard sangat pantas sambil memastikan **konvensi RESTful** (struktur URL yang konsisten dan semantik kaedah HTTP) diikuti secara automatik.

Viewset kekal fleksibel — anda menyesuaikannya dengan menggantikan kaedah (menapis queryset setiap pengguna, mengawal kebenaran, mengaitkan ke cipta/kemas kini) dan menambah **tindakan tersuai** (`@action`) untuk titik akhir di luar CRUD asas.

Memahami viewset dan router, cara ia menjana titik akhir, cara menyesuaikannya, dan **bila untuk menggunakannya** (sumber REST konvensional) berbanding generic view yang lebih jelas atau APIView (titik akhir tersuai/bukan standard) ialah pengetahuan praktikal yang penting untuk pembangunan DRF.

Memandangkan membina REST API ialah penggunaan utama Django pada hari ini, dan viewset+router ialah cara idiomatik dan paling produktif untuk melakukannya bagi sumber standard, ia ialah bahagian yang penting dan kerap digunakan dalam set alat DRF yang membolehkan pembangun membina API yang teguh dengan kod minimum sambil mengekalkan fleksibiliti untuk mengendalikan keperluan tersuai.