DRFのviewsetsとroutersとは何ですか？

Question

Accepted Answer

Django REST Frameworkでは、**viewsets**は関連するAPI エンドポイントのセット（リソースのCRUD操作）のロジックを単一のクラスにグループ化し、**routers**はそれらのURLルーティングを自動生成します。この2つを組み合わせることで、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`は、queryset とserializerだけから、モデルの**完全なRESTful CRUDエンドポイントのセット**（list、create、retrieve、update、partial update、delete）を自動的に提供します。各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を標準的なRESTful URLの完全なセットに自動的にマッピングします。1つのviewsetを登録すると、正しいHTTPメソッド付きのすべての従来のエンドポイントが生成され、手動の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は、メソッド（`get_queryset`、`perform_create`）のオーバーライド、パーミッション設定、標準CRUDを超えるエンドポイント用の**カスタムアクション**（`@action`）追加によってカスタマイズできます。

## 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はRESTful APIを効率的に構築するためのDRFの強力な機能です。これらは極めて一般的なモデルをフルなRESTリソースとして公開するケースに対する最高レベルの抽象化を表しており、これを理解することは生産的なAPI開発に価値があります。

主な利点は劇的な**ボイラープレート削減**です。`ModelViewSet`とrouterの組み合わせで、queryset とserializerだけから、完全で従来的なREST API（正しいHTTPメソッドとURLを持つすべてのCRUDエンドポイント）を得ることができます。これは、本来であれば多くの個別viewと手動のURLパターンが必要なものを置き換えます。

これにより、標準的なREST APIの構築が驚くほど高速になり、同時に**RESTful規約**（一貫したURL構造とHTTPメソッドセマンティクス）が自動的に従われることが保証されます。

Viewsetsは柔軟性を保ち続けます。メソッドのオーバーライド（ユーザーごとのqueryset フィルタリング、パーミッション制御、create/updateへのフック）とBasic CRUD以上のエンドポイント用の**カスタムアクション**（`@action`）追加によってカスタマイズできます。

Viewsetsとroutersがどのようにエンドポイントを生成するか、それらをどのようにカスタマイズするか、そして**いつそれらを使用するか**（従来的なRESTリソース）対して、より明示的なgeneric viewsまたはAPIView（カスタム/非標準エンドポイント）を使用するかを理解することは、DRF開発の重要な実践的知識です。

REST APIの構築は今日のDjangoの主要な用途であり、viewsets+routersは標準リソースに対する慣用的で最も生産的な方法であるため、これらはDRFツールキットの頻繁に使用される重要な部分であり、開発者がカスタム要件に対応する柔軟性を保ちながら、最小限のコードで堅牢なAPIを構築できるようにします。