Что такое viewsets и routers в Django REST Framework?

Question

Accepted Answer

В Django REST Framework **viewsets** объединяют логику набора связанных API endpoints (операции CRUD для ресурса) в один класс, а **routers** автоматически генерируют маршрутизацию URL для них. Вместе они драматически сокращают шаблонный код при построении RESTful API.

## 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` автоматически предоставляет **полный набор RESTful CRUD endpoints** для модели — list, create, retrieve, update, partial update и delete — из простого queryset и serializer. Нет необходимости писать каждое представление отдельно.

## 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 на полный набор стандартных RESTful URL автоматически — регистрация одного viewset генерирует все обычные endpoints с правильными HTTP методами, исключая необходимость ручной конфигурации URL.

## 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 настраиваются путём переопределения методов (`get_queryset`, `perform_create`), установки прав доступа и добавления **пользовательских действий** (`@action`) для endpoints за пределами стандартного 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.
```

## Почему это важно

Viewsets и routers — мощная функция DRF для эффективного построения RESTful API — они представляют высший уровень абстракции для чрезвычайно распространённого случая, когда модель выставляется как полный REST ресурс, и их понимание ценно для продуктивной разработки API.

Ключевое преимущество — драматическое **сокращение шаблонного кода**: `ModelViewSet` плюс router даёт вам полный, конвенциональный REST API для ресурса (все CRUD endpoints с правильными HTTP методами и URL) из простого queryset и serializer — заменяя то, что иначе было бы множеством отдельных представлений и ручных URL паттернов.

Это делает построение стандартных REST API замечательно быстрым, обеспечивая при этом соблюдение **RESTful соглашений** (согласованная структура URL и семантика HTTP методов) автоматически.

Viewsets остаются гибкими — вы настраиваете их переопределением методов (фильтрация queryset для каждого пользователя, управление правами доступа, встраивание в create/update) и добавлением **пользовательских действий** (`@action`) для endpoints за пределами базового CRUD.

Понимание viewsets и routers, как они генерируют endpoints, как их настраивать и **когда их использовать** (конвенциональные REST ресурсы) в сравнении с более явными generic views или APIView (пользовательские/нестандартные endpoints) — важное практическое знание для разработки на DRF.

Поскольку построение REST API — первичное назначение Django сегодня, а viewsets+routers — идиоматичный, наиболее продуктивный способ это делать для стандартных ресурсов, они часто используемая, важная часть инструментария DRF, которая позволяет разработчикам строить надёжные API с минимальным кодом, сохраняя гибкость для обработки пользовательских требований.