DRF viewset และ router คืออะไร?

Question

Accepted Answer

ใน Django REST Framework **viewset** จะรวมตรรกะของ endpoint API ที่เกี่ยวข้องกันชุดหนึ่ง (การทำ CRUD สำหรับ resource หนึ่ง) ไว้ในคลาสเดียว และ **router** จะสร้าง URL routing ให้โดยอัตโนมัติ เมื่อใช้ร่วมกันทั้งสองช่วยลด boilerplate ในการสร้าง 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` ให้ **endpoint CRUD แบบ RESTful ครบชุด** สำหรับ model โดยอัตโนมัติ — list, create, retrieve, update, partial update และ delete — จากเพียง queryset และ serializer ไม่ต้องเขียนแต่ละ view แยกกัน

## Router — สร้าง 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 แบบ RESTful มาตรฐานครบชุดโดยอัตโนมัติ — การ register viewset เพียงตัวเดียวจะสร้าง endpoint ตามแบบแผนทั้งหมดด้วย HTTP method ที่ถูกต้อง ขจัดการตั้งค่า URL ด้วยมือ

## การปรับแต่ง 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 ได้ด้วยการ override เมธอด (`get_queryset`, `perform_create`), ตั้งค่า permission และเพิ่ม **custom action** (`@action`) สำหรับ endpoint นอกเหนือจาก CRUD มาตรฐาน

## Viewset เทียบกับ 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.
```

## ทำไมจึงสำคัญ

viewset และ router เป็นฟีเจอร์ที่ทรงพลังของ DRF สำหรับการสร้าง RESTful API อย่างมีประสิทธิภาพ — เป็นนามธรรมระดับสูงสุดสำหรับกรณีที่พบบ่อยมากอย่างการเปิดเผย model เป็น REST resource แบบครบชุด และการเข้าใจมันมีค่าต่อการพัฒนา API ที่มีประสิทธิภาพ

ประโยชน์สำคัญคือ **การลด boilerplate อย่างมาก**: `ModelViewSet` บวกกับ router ให้ REST API ที่สมบูรณ์ตามแบบแผนสำหรับ resource หนึ่ง (endpoint CRUD ครบชุดด้วย HTTP method และ URL ที่ถูกต้อง) จากเพียง queryset และ serializer — แทนที่สิ่งที่ปกติต้องเขียน view แยกกันหลายตัวและตั้งค่า URL ด้วยมือ

สิ่งนี้ทำให้การสร้าง REST API มาตรฐานรวดเร็วอย่างน่าทึ่ง ในขณะเดียวกันก็รับประกันว่า **แบบแผน RESTful** (โครงสร้าง URL ที่สอดคล้องและความหมายของ HTTP method) ถูกปฏิบัติตามโดยอัตโนมัติ

viewset ยังคงยืดหยุ่น — คุณปรับแต่งได้ด้วยการ override เมธอด (กรอง queryset ต่อผู้ใช้, ควบคุม permission, hook เข้ากับการ create/update) และเพิ่ม **custom action** (`@action`) สำหรับ endpoint นอกเหนือจาก CRUD พื้นฐาน

การเข้าใจ viewset และ router, วิธีที่มันสร้าง endpoint, วิธีปรับแต่ง และ **เมื่อใดควรใช้** (REST resource ตามแบบแผน) เทียบกับ generic view ที่ชัดเจนกว่าหรือ APIView (endpoint แบบกำหนดเอง/ไม่เป็นมาตรฐาน) คือความรู้เชิงปฏิบัติที่สำคัญสำหรับการพัฒนา DRF

เนื่องจากการสร้าง REST API เป็นการใช้งานหลักของ Django ในปัจจุบัน และ viewset+router เป็นวิธีที่เป็นสำนวนและให้ประสิทธิภาพสูงสุดในการทำสำหรับ resource มาตรฐาน มันจึงเป็นส่วนหนึ่งของชุดเครื่องมือ DRF ที่ใช้บ่อยและสำคัญ ซึ่งช่วยให้นักพัฒนาสร้าง API ที่ทนทานได้ด้วยโค้ดที่น้อยที่สุด ในขณะที่ยังคงความยืดหยุ่นในการรองรับความต้องการแบบกำหนดเอง