Django REST Framework視圖

Django REST Framework (DRF) 視圖類詳解

DRF 提供了豐富的視圖類來構建 API，從基礎到高級，滿足不同復雜度的需求。以下是 DRF 的主要視圖類及其使用場景：

1. 基礎視圖類

APIView

所有 DRF 視圖的基類，相當于 Django 的 View 類的增強版。

from rest_framework.views import APIView
from rest_framework.response import Responseclass ArticleAPIView(APIView):def get(self, request):articles = Article.objects.all()serializer = ArticleSerializer(articles, many=True)return Response(serializer.data)def post(self, request):serializer = ArticleSerializer(data=request.data)if serializer.is_valid():serializer.save()return Response(serializer.data, status=201)return Response(serializer.errors, status=400)

特點：

提供了 Django View 的所有功能
增加了 DRF 的請求/響應處理
內置了認證、權限、限流等機制

2. 通用視圖類 (Generic Views)

GenericAPIView

擴展了 APIView，增加了常見的列表和詳情視圖行為。

from rest_framework.generics import GenericAPIViewclass ArticleList(GenericAPIView):queryset = Article.objects.all()serializer_class = ArticleSerializerdef get(self, request):queryset = self.get_queryset()serializer = self.get_serializer(queryset, many=True)return Response(serializer.data)

具體通用視圖

DRF 提供了5個具體的通用視圖類：

ListAPIView?- 只讀列表

from rest_framework.generics import ListAPIViewclass ArticleList(ListAPIView):queryset = Article.objects.all()serializer_class = ArticleSerializer

RetrieveAPIView?- 只讀單個實例

from rest_framework.generics import RetrieveAPIViewclass ArticleDetail(RetrieveAPIView):queryset = Article.objects.all()serializer_class = ArticleSerializer

CreateAPIView?- 只創建

from rest_framework.generics import CreateAPIViewclass ArticleCreate(CreateAPIView):queryset = Article.objects.all()serializer_class = ArticleSerializer

UpdateAPIView?- 只更新

from rest_framework.generics import UpdateAPIViewclass ArticleUpdate(UpdateAPIView):queryset = Article.objects.all()serializer_class = ArticleSerializer

DestroyAPIView?- 只刪除

from rest_framework.generics import DestroyAPIViewclass ArticleDelete(DestroyAPIView):queryset = Article.objects.all()serializer_class = ArticleSerializer

組合通用視圖

ListCreateAPIView?- 列表 + 創建

from rest_framework.generics import ListCreateAPIViewclass ArticleListCreate(ListCreateAPIView):queryset = Article.objects.all()serializer_class = ArticleSerializer

RetrieveUpdateAPIView?- 詳情 + 更新

from rest_framework.generics import RetrieveUpdateAPIViewclass ArticleRetrieveUpdate(RetrieveUpdateAPIView):queryset = Article.objects.all()serializer_class = ArticleSerializer

RetrieveDestroyAPIView?- 詳情 + 刪除

from rest_framework.generics import RetrieveDestroyAPIViewclass ArticleRetrieveDestroy(RetrieveDestroyAPIView):queryset = Article.objects.all()serializer_class = ArticleSerializer

RetrieveUpdateDestroyAPIView?- 詳情 + 更新 + 刪除

from rest_framework.generics import RetrieveUpdateDestroyAPIViewclass ArticleRUD(RetrieveUpdateDestroyAPIView):queryset = Article.objects.all()serializer_class = ArticleSerializer

3. 視圖集 (ViewSets)

ViewSet

將多個視圖邏輯組合到一個類中。

from rest_framework.viewsets import ViewSetclass ArticleViewSet(ViewSet):def list(self, request):queryset = Article.objects.all()serializer = ArticleSerializer(queryset, many=True)return Response(serializer.data)def retrieve(self, request, pk=None):article = get_object_or_404(Article, pk=pk)serializer = ArticleSerializer(article)return Response(serializer.data)

GenericViewSet

結合了 GenericAPIView 和 ViewSet 的行為。

from rest_framework.viewsets import GenericViewSetclass ArticleViewSet(GenericViewSet):queryset = Article.objects.all()serializer_class = ArticleSerializerdef list(self, request):queryset = self.get_queryset()serializer = self.get_serializer(queryset, many=True)return Response(serializer.data)

ModelViewSet

提供完整的 CRUD 操作。

from rest_framework.viewsets import ModelViewSetclass ArticleViewSet(ModelViewSet):queryset = Article.objects.all()serializer_class = ArticleSerializer# 自動獲得 list, create, retrieve, update, destroy 方法

ReadOnlyModelViewSet

只提供只讀操作。

from rest_framework.viewsets import ReadOnlyModelViewSetclass ArticleViewSet(ReadOnlyModelViewSet):queryset = Article.objects.all()serializer_class = ArticleSerializer# 自動獲得 list 和 retrieve 方法

4. 自定義動作

可以在 ViewSet 中添加自定義路由和方法：

from rest_framework.decorators import action
from rest_framework.response import Responseclass ArticleViewSet(ModelViewSet):queryset = Article.objects.all()serializer_class = ArticleSerializer@action(detail=True, methods=['post'])def publish(self, request, pk=None):article = self.get_object()article.published = Truearticle.save()return Response({'status': 'published'})@action(detail=False)def recent(self, request):recent_articles = Article.objects.order_by('-created_at')[:5]serializer = self.get_serializer(recent_articles, many=True)return Response(serializer.data)

5. 其他特殊視圖

mixins

可以組合使用的混合類：

ListModelMixin?- 提供列表功能
CreateModelMixin?- 提供創建功能
RetrieveModelMixin?- 提供詳情功能
UpdateModelMixin?- 提供更新功能
DestroyModelMixin?- 提供刪除功能

from rest_framework import mixins
from rest_framework.viewsets import GenericViewSetclass ArticleViewSet(mixins.ListModelMixin,mixins.CreateModelMixin,GenericViewSet):queryset = Article.objects.all()serializer_class = ArticleSerializer

視圖選擇指南

簡單API：使用 APIView 或 GenericAPIView
標準CRUD：使用通用視圖 (ListCreateAPIView 等) 或 ModelViewSet
只讀API：使用 ReadOnlyModelViewSet
需要自定義行為：使用 ViewSet 或 GenericViewSet 配合 mixins
復雜邏輯：從 APIView 繼承并自行實現

路由配置示例

# 對于 ViewSet
from rest_framework.routers import DefaultRouterrouter = DefaultRouter()
router.register(r'articles', ArticleViewSet)urlpatterns = [path('', include(router.urls)),
]# 對于通用視圖
urlpatterns = [path('articles/', ArticleList.as_view()),path('articles/<int:pk>/', ArticleDetail.as_view()),
]

DRF 的視圖系統非常靈活，可以根據項目需求選擇合適的視圖類，從簡單到復雜都能很好地支持。

應用示例

創建一個django項目

創建 Django 項目
django-admin startproject test_restcd test_rest
創建應用
python manage.py startapp myapp

?下載

pip install djangorestframework

django項目注釋掉一些不需要的，然后注冊rest_framework

注釋INSTALLED_APPS，MIDDLEWARE，TEMPLATES里自帶的一些內容

#settings.py"""
Django settings for test_rest project.Generated by 'django-admin startproject' using Django 5.2.5.For more information on this file, see
https://docs.djangoproject.com/en/5.2/topics/settings/For the full list of settings and their values, see
https://docs.djangoproject.com/en/5.2/ref/settings/
"""from pathlib import Path# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = Path(__file__).resolve().parent.parent# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/5.2/howto/deployment/checklist/# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = 'django-insecure-!07)9y63bmcjs7__+me1a^sirkne20g1lz37bqrt&rt#%(5g1h'# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = TrueALLOWED_HOSTS = []# Application definitionINSTALLED_APPS = [# 'django.contrib.admin','django.contrib.auth','django.contrib.contenttypes',# 'django.contrib.sessions',# 'django.contrib.messages','django.contrib.staticfiles',"rest_framework"
]MIDDLEWARE = ['django.middleware.security.SecurityMiddleware',#'django.contrib.sessions.middleware.SessionMiddleware','django.middleware.common.CommonMiddleware','django.middleware.csrf.CsrfViewMiddleware',# 'django.contrib.auth.middleware.AuthenticationMiddleware',# 'django.contrib.messages.middleware.MessageMiddleware','django.middleware.clickjacking.XFrameOptionsMiddleware',
]ROOT_URLCONF = 'test_rest.urls'TEMPLATES = [{'BACKEND': 'django.template.backends.django.DjangoTemplates','DIRS': [],'APP_DIRS': True,'OPTIONS': {'context_processors': ['django.template.context_processors.request',# 'django.contrib.auth.context_processors.auth',# 'django.contrib.messages.context_processors.messages',],},},
]WSGI_APPLICATION = 'test_rest.wsgi.application'# Database
# https://docs.djangoproject.com/en/5.2/ref/settings/#databasesDATABASES = {'default': {'ENGINE': 'django.db.backends.sqlite3','NAME': BASE_DIR / 'db.sqlite3',}
}# Password validation
# https://docs.djangoproject.com/en/5.2/ref/settings/#auth-password-validatorsAUTH_PASSWORD_VALIDATORS = [{'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',},{'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',},{'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',},{'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',},
]# Internationalization
# https://docs.djangoproject.com/en/5.2/topics/i18n/LANGUAGE_CODE = 'en-us'TIME_ZONE = 'UTC'USE_I18N = TrueUSE_TZ = True# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/5.2/howto/static-files/STATIC_URL = 'static/'# Default primary key field type
# https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-fieldDEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

Django REST Framework (DRF) 中的 FBV 與 CBV

FBV（Function-Based Views，函數基礎視圖）和 CBV（Class-Based Views，類基礎視圖）是 Django 和 Django REST Framework (DRF) 中實現視圖邏輯的兩種主要方式。

test_rest/urls.py"""
URL configuration for test_rest project.The `urlpatterns` list routes URLs to views. For more information please see:https://docs.djangoproject.com/en/5.2/topics/http/urls/
Examples:
Function views1. Add an import:  from my_app import views2. Add a URL to urlpatterns:  path('', views.home, name='home')
Class-based views1. Add an import:  from other_app.views import Home2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
Including another URLconf1. Import the include() function: from django.urls import include, path2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
"""
from django.urls import path,include
from myapp import viewsurlpatterns = [path('auth/',views.auth), #FBVpath('myview/',views.MyView.as_view()),#CBVpath('info/',views.MyView.as_view()),#CBV]

/myapp/views.py

from django.http import JsonResponse
from django.views import View
from rest_framework.views import APIView
from rest_framework.response import Responsedef auth(request):if request.method == "GET":return JsonResponse({"status":True,'message':'success',"method":request.method})elif request.method == "POST":return JsonResponse({"status":True,'message':'success',"method":request.method})return JsonResponse({"status":False,"method":request.method})class MyView(View):def get(self,request):return JsonResponse({"status":True,'message':'success',"method":request.method})def post(self,request):return JsonResponse({"status":True,'message':'success',"method":request.method})def put(self,request):return JsonResponse({"status":True,'message':'success',"method":request.method})def delete(self,request):return JsonResponse({"status":True,'message':'success',"method":request.method})class InfoView(APIView):def get(self,request):return Response({"status":True,'message':'success',"method":request.method})

Django REST Framework (DRF) 視圖類詳解

DRF 提供了豐富的視圖類來構建 API，從基礎到高級，滿足不同復雜度的需求。以下是 DRF 的主要視圖類及其使用場景：

開始前咱們先創建一個數據庫，模型類，然后遷移數據

?一、MySQL 數據庫配置

1. 安裝 MySQL 驅動

pip install mysqlclient  # 推薦
# 或
pip install pymysql

2. 創建 MySQL 數據庫

CREATE DATABASE backstage CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

3. 配置 Django 的 settings.py

# settings.py
DATABASES = {'default': {  # 默認數據庫配置（Django 支持多數據庫配置）'ENGINE': 'django.db.backends.mysql',  # 指定使用 MySQL 后端'NAME': 'backstage',                   # 數據庫名（需提前創建）'USER': 'your_username',               # MySQL 用戶名'PASSWORD': 'your_password',           # MySQL 密碼'HOST': 'localhost',                   # 數據庫服務器地址（默認本地）'PORT': '3306',                        # MySQL 默認端口'OPTIONS': {                           # 額外選項（關鍵配置）'charset': 'utf8mb4',              # 字符集設置為 utf8mb4'init_command': "SET sql_mode='STRICT_TRANS_TABLES'",  # 初始化 SQL 命令}}
}

?二、創建商品模型

定義模型（myapp/models.py）

from django.db import models
from django.core.validators import MinValueValidatorclass SpecificationCategory(models.Model):"""規格類目表"""id = models.AutoField(primary_key=True, verbose_name="商品ID")name = models.CharField(max_length=50, verbose_name="規格類目名稱")cid = models.CharField(max_length=50, verbose_name="類目編號")class Meta:db_table = 'spec_category'verbose_name = '商品規格類目'verbose_name_plural = verbose_namedef __str__(self):return self.nameclass Product(models.Model):"""商品表"""id = models.AutoField(primary_key=True, verbose_name="商品ID")price = models.DecimalField(max_digits=10,decimal_places=2,validators=[MinValueValidator(0)],verbose_name="商品價格")stock = models.PositiveIntegerField(default=0, verbose_name="商品庫存")# 一對多關聯規格類目spec_category = models.ForeignKey(SpecificationCategory,on_delete=models.PROTECT,related_name='products',  # 注意改為復數形式verbose_name="規格類目")image = models.CharField(max_length=500,blank=True,null=True,verbose_name="商品主圖URL")selling_points = models.CharField(max_length=200,blank=True,verbose_name="商品賣點")description = models.TextField(verbose_name="商品詳情描述")# 自動記錄時間created_at = models.DateTimeField(auto_now_add=True, verbose_name="創建時間")updated_at = models.DateTimeField(auto_now=True, verbose_name="更新時間")class Meta:db_table = 'product'verbose_name = '商品信息'verbose_name_plural = verbose_nameordering = ['-created_at']def __str__(self):return f"商品{self.id}（庫存：{self.stock}）"

?三、數據庫遷移

注意要在settings.py里注冊app哦

1. 生成遷移文件

python manage.py makemigrations myapp

2. 查看生成的SQL（可選）

python manage.py sqlmigrate myapp 0001

3. 執行遷移

python manage.py migrate

示例

?1. 首先創建序列化器

在?serializers.py?中：

from rest_framework import serializers
from .models import Product, SpecificationCategoryclass SpecificationCategorySerializer(serializers.ModelSerializer):class Meta:model = SpecificationCategoryfields = ['id', 'name', 'cid']class ProductSerializer(serializers.ModelSerializer):# 保留只讀的嵌套表示spec_category = SpecificationCategorySerializer(read_only=True)# 改為只接受spec_category的IDspec_category_id = serializers.PrimaryKeyRelatedField(queryset=SpecificationCategory.objects.all(),source='spec_category',write_only=True)class Meta:model = Productfields = ['id', 'price', 'stock', 'spec_category','image', 'selling_points', 'description','created_at', 'updated_at']read_only_fields = ['created_at', 'updated_at']

APIView 使用示例

2. 創建 APIView 視圖

在?views.py?中：

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status
from .models import Product
from .serializers import ProductSerializer
from django.shortcuts import get_object_or_404class ProductAPIView(APIView):"""商品API視圖，支持列表獲取和創建"""def get(self, request, format=None):"""獲取所有商品列表"""products = Product.objects.all()serializer = ProductSerializer(products, many=True)return Response(serializer.data)def post(self, request, format=None):"""創建新商品"""serializer = ProductSerializer(data=request.data)if serializer.is_valid():serializer.save()return Response(serializer.data, status=status.HTTP_201_CREATED)return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)class ProductDetailAPIView(APIView):"""商品詳情API視圖，支持檢索、更新和刪除單個商品"""def get_object(self, pk):return get_object_or_404(Product, pk=pk)def get(self, request, pk, format=None):"""獲取單個商品詳情"""product = self.get_object(pk)serializer = ProductSerializer(product)return Response(serializer.data)def put(self, request, pk, format=None):"""更新整個商品信息"""product = self.get_object(pk)serializer = ProductSerializer(product, data=request.data)if serializer.is_valid():serializer.save()return Response(serializer.data)return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)def patch(self, request, pk, format=None):"""部分更新商品信息"""product = self.get_object(pk)serializer = ProductSerializer(product, data=request.data, partial=True)if serializer.is_valid():serializer.save()return Response(serializer.data)return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)def delete(self, request, pk, format=None):"""刪除商品"""product = self.get_object(pk)product.delete()return Response(status=status.HTTP_204_NO_CONTENT)

3. 配置 URL 路由

在?urls.py?中：

from django.urls import path
from myapp.views import ProductAPIView,ProductDetailAPIViewurlpatterns = [path('products/', ProductAPIView.as_view(), name='product-list'),path('products/<int:pk>/', ProductDetailAPIView.as_view(), name='product-detail'),
]

訪問：

ViewSets的ModelViewSet示例

?2. 創建 APIView 視圖

在?views.py?中：

from .models import Product,SpecificationCategory
from .serializers import ProductSerializer,SpecificationCategorySerializer
from rest_framework import viewsetsclass SpecificationCategoryViewSet(viewsets.ModelViewSet):queryset = SpecificationCategory.objects.all()serializer_class = SpecificationCategorySerializerclass ProductViewSet(viewsets.ModelViewSet):queryset = Product.objects.all()serializer_class = ProductSerializer

3. 配置 URL 路由

在?urls.py?中：

from django.urls import path, include
from myapp.views import *
from rest_framework.routers import DefaultRouterrouter = DefaultRouter()
router.register('spec-categories', SpecificationCategoryViewSet)
router.register('products_view', ProductViewSet)
urlpatterns = [path('api/', include(router.urls)),  # 注意這里包含了路由
]

訪問：