DRF viewset과 router란 무엇인가요?

Question

Accepted Answer

Django REST Framework에서 **viewset**은 관련된 API 엔드포인트 집합(리소스의 CRUD 작업)의 로직을 단일 클래스로 묶고, **router**는 그에 대한 URL 라우팅을 자동으로 생성합니다. 둘을 함께 사용하면 RESTful API 구축의 보일러플레이트를 극적으로 줄입니다.

## ModelViewSet — 몇 줄로 전체 CRUD

```python
from rest_framework import viewsets

class ArticleViewSet(viewsets.ModelViewSet):
    queryset = Article.objects.all()             # 데이터
    serializer_class = ArticleSerializer          # 직렬화 방법
    # 이것이 전부! 모든 표준 CRUD 엔드포인트를 자동 제공:
    #   list (GET), create (POST), retrieve (GET /id), update (PUT/PATCH /id), destroy (DELETE /id)
```

`ModelViewSet`은 queryset과 serializer만으로 model에 대한 **완전한 RESTful CRUD 엔드포인트 집합**—목록, 생성, 조회, 수정, 부분 수정, 삭제—을 자동 제공합니다. 각 view를 따로 작성할 필요가 없습니다.

## router — 자동 URL 생성

```python
from rest_framework.routers import DefaultRouter

router = DefaultRouter()
router.register(r"articles", ArticleViewSet)     # viewset 등록

urlpatterns = router.urls
# RESTful URL을 자동 생성:
#   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 하나를 등록하면 올바른 HTTP 메서드와 함께 모든 관례적 엔드포인트가 생성되어, 수동 URL 설정을 제거합니다.

## viewset 커스터마이징

```python
class ArticleViewSet(viewsets.ModelViewSet):
    serializer_class = ArticleSerializer
    permission_classes = [IsAuthenticated]        # 인가

def get_queryset(self):                        # 요청별로 데이터 커스터마이징
        return Article.objects.filter(author=self.request.user)

# @action으로 CRUD 외의 커스텀 엔드포인트 추가
    @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은 메서드(`get_queryset`, `perform_create`)를 재정의하고, 권한을 설정하고, 표준 CRUD 외의 엔드포인트를 위한 **커스텀 액션**(`@action`)을 추가하여 커스터마이징합니다.

## viewset vs 제네릭 API view

```text
ModelViewSet  → 한 클래스에 모든 CRUD + router → 표준 REST 리소스에 최소 코드
제네릭 view(ListCreateAPIView 등) → 더 명시적, 엔드포인트 그룹당 한 클래스
APIView       → 비표준/커스텀 엔드포인트를 위한 완전 수동 제어
→ 관례적 REST 리소스에는 viewset+router; 커스텀 요구에는 제네릭/APIView 사용.
```

## 왜 중요한가

viewset과 router는 RESTful API를 효율적으로 구축하는 강력한 DRF 기능입니다. model을 완전한 REST 리소스로 노출하는 매우 흔한 경우에 대한 최고 수준의 추상화를 나타내며, 이를 이해하는 것은 생산적인 API 개발에 가치가 있습니다.

핵심 이점은 극적인 **보일러플레이트 감소**입니다: `ModelViewSet`과 router를 합치면 queryset과 serializer만으로 리소스에 대한 완전한 관례적 REST API(올바른 HTTP 메서드와 URL을 가진 모든 CRUD 엔드포인트)를 얻습니다. 그렇지 않으면 많은 개별 view와 수동 URL 패턴이 필요했을 것입니다.

이는 표준 REST API 구축을 놀랍도록 빠르게 만들면서 **RESTful 관례**(일관된 URL 구조와 HTTP 메서드 의미)가 자동으로 따라지도록 보장합니다.

viewset은 유연성을 유지합니다. 메서드를 재정의(사용자별로 queryset 필터링, 권한 제어, 생성/업데이트에 후킹)하고 기본 CRUD 외의 엔드포인트를 위한 **커스텀 액션**(`@action`)을 추가하여 커스터마이징합니다.

viewset과 router를 이해하고, 어떻게 엔드포인트를 생성하는지, 어떻게 커스터마이징하는지, 그리고 **언제 사용할지**(관례적 REST 리소스) 대 더 명시적인 제네릭 view나 APIView(커스텀/비표준 엔드포인트)를 아는 것은 DRF 개발에 중요한 실용 지식입니다.

오늘날 REST API 구축이 Django의 주요 용도이고, viewset+router가 표준 리소스에 대해 관용적이고 가장 생산적인 방법이므로, 이들은 개발자가 최소한의 코드로 견고한 API를 구축하면서 커스텀 요구를 처리할 유연성을 유지하게 해주는, 자주 사용되는 중요한 DRF 도구입니다.