You need to enable JavaScript to run this app. Django Rest Framework 纯函数视图如何注册到路由器并显示在API根目录
优惠活动
大模型
产品
解决方案
定价
更多

Django Rest Framework 纯函数视图如何注册到路由器并显示在API根目录

问题背景

现有代码

views.py 代码

class ChoicesViewSet(viewsets.ModelViewSet):
    queryset = SingleChoice.objects.all()
    serializer_class = SingleChoiceSerializer
    ...

class AssessmentTakersViewSet(viewsets.ModelViewSet):
    queryset = AssessmentTaker.objects.all()
    serializer_class = AssessmentTakersSerializer
    ...

@api_view(['POST'])
@parser_classes((JSONParser,))
def studio_create_view(request, format=None):
    """
    接收JSON格式POST请求,用于批量创建问题和选项,请求头需要指定为application/json
    """
    ... 

urls.py 代码

urlpatterns = [
    # http://localhost:8000/survey/api/studio-create
    path('api/studio-create', views.studio_create_view, name='studio-create-api'),
]

# drf配置
router = routers.DefaultRouter()

router.register('api/choices', views.ChoicesViewSet)
router.register('api/assessment-takers', views.AssessmentTakersViewSet)

urlpatterns += router.urls

问题现象

当前功能可以正常运行,但studio_create_view没有注册到DRF路由器中,因此不会出现在DRF返回的API根目录列表中,不利于接口文档展示。向根路径发起GET请求时返回内容如下:

http://localhost:8000/survey/

HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "api/choices": "http://localhost:8000/survey/api/choices/",
    "api/assessment-takers": "http://localhost:8000/survey/api/assessment-takers/",
    ...
}

尝试过的方案和报错

尝试用以下方式直接注册函数视图:

router.register('api/studio-create', views.studio_create_view, basename='studio-create-api')

运行抛出异常:

AttributeError: 'function' object has no attribute 'get_extra_actions'

省略name或basename参数也无法正常运行,报错如下:

AssertionError: basename argument not specified, and could not automatically determine the name from the viewset, as it does not have a .queryset attribute.

注意:studio_create_view是纯函数视图,未继承任何ViewSet或ModelViewSet类,因此继承ViewSet相关的解决方案不适用。

问题诉求

如何将这类自定义函数视图注册到DRF提供的路由器中,使其出现在API根目录的接口列表中?

解决方案

DRF的DefaultRouter默认仅支持注册ViewSet类实例,无法直接注册函数视图,你可以通过重写默认的APIRootView来添加自定义路径,步骤如下:

  1. 在urls.py中自定义APIRootView,手动加入你的函数视图路径:
from rest_framework import routers
from rest_framework.response import Response
from rest_framework.reverse import reverse

class CustomAPIRootView(routers.APIRootView):
    """
    自定义API根视图,添加额外的函数视图路径
    """
    def get(self, request, *args, **kwargs):
        response = super().get(request, *args, **kwargs)
        # 手动添加自定义路径,key是显示在根目录的名称,value是反向解析得到的url
        response.data['api/studio-create'] = reverse('studio-create-api', request=request, format=kwargs.get('format'))
        return response
  1. 自定义路由器类,指定使用上面的自定义根视图:
class CustomDefaultRouter(routers.DefaultRouter):
    APIRootView = CustomAPIRootView
  1. 替换原来的DefaultRouter为你自定义的路由器:
# 把原来的 router = routers.DefaultRouter() 替换为下面的代码
router = CustomDefaultRouter()

# 原有ViewSet注册逻辑不变
router.register('api/choices', views.ChoicesViewSet)
router.register('api/assessment-takers', views.AssessmentTakersViewSet)

urlpatterns += router.urls

修改完成后再访问API根路径,就能看到api/studio-create出现在返回的接口列表中,原有函数视图的功能不受任何影响。

内容的提问来源于stack exchange,提问作者onlyphantom

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.10.09 03:06:00