Django REST Framework中EmailViewSet配置后未在接口页面显示求助

问题根源 #

你当前使用的viewsets.ViewSet是DRF中最基础的ViewSet类，它没有内置任何默认的业务动作方法（比如list、retrieve、create这类标准CRUD动作）。DRF的路由注册器只会识别包含这些标准动作的ViewSet来生成路由，同时只有这类ViewSet才会被自动纳入接口文档页面。

解决办法 #

方案1：改用ModelViewSet（推荐，适合需要完整CRUD操作的场景）

直接替换ViewSet的继承类，ModelViewSet已经内置了所有标准CRUD动作，无需额外定义就能让路由和接口文档正常工作：

from rest_framework import viewsets

class EmailViewSet(viewsets.ModelViewSet):
    """
    A ViewSet for sending emails based on a template.
    """
    serializer_class = EmailTemplateSerializer
    queryset = EmailTemplate.objects.all()

    # 若需要自定义查询逻辑，保留该方法；无需的话可直接删除
    def get_queryset(self):
        return EmailTemplate.objects.all()   

方案2：改用ReadOnlyModelViewSet（仅需只读接口的场景）

如果只需要查看模板的功能，不需要创建/修改/删除，用这个类更轻量，它内置了list和retrieve两个只读动作：

from rest_framework import viewsets

class EmailViewSet(viewsets.ReadOnlyModelViewSet):
    """
    A ViewSet for viewing email templates.
    """
    serializer_class = EmailTemplateSerializer
    queryset = EmailTemplate.objects.all()

方案3：手动添加标准动作（自定义动作场景）

如果必须用viewsets.ViewSet，需要手动定义DRF路由器能识别的标准动作方法，比如添加list方法：

from rest_framework import viewsets, status
from rest_framework.response import Response

class EmailViewSet(viewsets.ViewSet):
    """
    A ViewSet for sending emails based on a template.
    """
    serializer_class = EmailTemplateSerializer
    queryset = EmailTemplate.objects.all()

    def list(self, request):
        queryset = self.get_queryset()
        serializer = self.serializer_class(queryset, many=True)
        return Response(serializer.data)

    def get_queryset(self):
        return EmailTemplate.objects.all()   

额外检查项 #

• 确认EmailTemplateSerializer已经正确导入到ViewSet所在的文件中
• 确保项目根urls.py里已经配置了路由器的URL映射，比如：

  from django.urls import path, include
  from rest_framework.routers import DefaultRouter
  
  router = DefaultRouter()
  router.register(r'profiles', ProfileViewSet, 'profile')
  router.register(r'emails', EmailViewSet, 'email')
  
  urlpatterns = [
      # 其他路由...
      path('', include(router.urls)),
  ]
  

内容的提问来源于stack exchange，提问作者Sushi Knight