ما هي ViewSets و Routers في Django REST Framework؟

Question

Accepted Answer

في Django REST Framework، تجمع **viewsets** منطق مجموعة من نقاط النهاية (endpoints) ذات الصلة - عمليات CRUD لمورد ما - في فئة واحدة، و **routers** تولد توجيه URL تلقائياً لها. معاً، تقللان بشكل كبير من الأكواد النمطية عند بناء واجهات برمجية RESTful.

## ModelViewSet — كامل CRUD في بضعة أسطر

```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` يوفر تلقائياً **مجموعة كاملة من نقاط نهاية CRUD الخاصة بـ REST** لنموذج ما — list و create و retrieve و update و partial update و delete — من مجرد queryset و serializer. لا حاجة لكتابة كل view على حدة.

## Routers — توليد 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** يربط viewset مع مجموعة كاملة من عناوين URL القياسية الخاصة بـ REST تلقائياً — تسجيل viewset واحد يولد جميع endpoints التقليدية بـ HTTP methods صحيحة، مما يلغي الحاجة لإعدادات URL يدوية.

## تخصيص 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 بواسطة override للدوال (`get_queryset` و `perform_create`)، وتعيين صلاحيات، وإضافة **custom actions** (`@action`) لنقاط نهاية خارج CRUD القياسي.

## Viewsets مقابل 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.
```

## لماذا هذا مهم

Viewsets و routers هما ميزة قوية في DRF لبناء واجهات برمجية RESTful بكفاءة — يمثلان أعلى مستوى من التجريد للحالة الشائعة جداً وهي expose نموذج كمورد REST كامل، وفهمها ذو قيمة لتطوير API منتج.

الفائدة الرئيسية هي **تقليل الأكواد النمطية** بشكل درامي: `ModelViewSet` مع router يعطيك واجهة برمجية REST كاملة وتقليدية لمورد (جميع endpoints CRUD بـ HTTP methods وعناوين URL صحيحة) من مجرد queryset و serializer — ما يحل محل عدة views وأنماط URL يدوية.

هذا يجعل بناء واجهات برمجية REST قياسية سريع بشكل ملحوظ مع ضمان اتباع **معايير RESTful** (هيكل URL متسق ودلالات HTTP method) تلقائياً.

Viewsets تبقى مرنة — تخصصها بواسطة override للدوال (تصفية queryset لكل مستخدم، التحكم بالصلاحيات، ربط create/update) وإضافة **custom actions** (`@action`) لنقاط نهاية خارج CRUD الأساسي.

فهم viewsets و routers، كيف تولد endpoints، كيف تخصصها، و **متى تستخدمها** (موارد REST تقليدية) مقابل generic views أو APIView (endpoints مخصصة/غير قياسية) هو معرفة عملية مهمة لتطوير DRF.

بما أن بناء واجهات برمجية REST هو الاستخدام الأساسي لـ Django اليوم، و viewsets+routers هي الطريقة الاصطلاحية والأكثر إنتاجية للقيام بذلك للموارد القياسية، فهي جزء مستخدم بتكرار ومهم من أدوات DRF التي تسمح للمطورين ببناء واجهات برمجية قوية بأقل كود مع الحفاظ على المرونة للتعامل مع المتطلبات المخصصة.