DRF默认API根视图未列出API接口的问题排查与解决

问题原因 #

你猜的没错，问题确实出在注册路由时使用的正则表达式r"access/(?P<endpoint>.+)"上。DRF的DefaultRouter生成API根视图时，会解析每个注册的路由前缀——只有当前缀是固定路径（不包含URL捕获组）时，才会被识别为可展示的顶级端点。带捕获组的前缀无法被Router正确解析为基础入口，因此不会出现在根视图的可用端点列表中。

解决方案 #

方案1：调整路由结构（推荐） #

把endpoint参数作为ViewSet的动作参数，而非路由前缀的一部分，让Router能正常识别基础端点：

修改service/urls.py：

from .views import AccessViewSet, CheckViewSet

app_name = "api"

router = DefaultRouter()
# 去掉前缀里的捕获组，只保留基础路径
router.register(r"access", AccessViewSet, basename="access")
router.register(r"check", CheckViewSet, basename="check")

urlpatterns = [
    path("", include(router.urls)),
]

然后在对应的ViewSet中，通过pk参数获取原来的endpoint值（或者用自定义动作）：

from rest_framework import viewsets
from rest_framework.response import Response

class AccessViewSet(viewsets.ViewSet):
    # 用retrieve动作处理单个endpoint请求
    def retrieve(self, request, pk=None):
        endpoint = pk
        # 在这里写你的业务逻辑
        return Response({"endpoint": endpoint, "message": "success"})

    # 也可以用@action定义自定义动作
    @action(detail=True, methods=["get"], url_path="custom")
    def custom_action(self, request, pk=None):
        return Response({"endpoint": pk, "action": "custom"})

这样调整后，Router会自动在API根视图中显示access/和check/两个顶级端点，点击后还能看到对应的子动作链接。

方案2：自定义API根视图（保留原路由结构） #

如果必须保留access/<endpoint>/的路由格式，可以手动自定义根视图，添加需要展示的端点链接：

1. 在service/views.py中添加自定义根视图：

from rest_framework.views import APIView
from rest_framework.response import Response

class CustomAPIRootView(APIView):
    def get(self, request, *args, **kwargs):
        # 构建端点的绝对URL
        return Response({
            "access": request.build_absolute_uri("access/"),
            "check": request.build_absolute_uri("check/"),
            # 可以添加示例链接，方便测试
            "access-example": request.build_absolute_uri("access/test-endpoint/")
        })

2. 修改service/urls.py，替换Router的默认根视图：

from .views import AccessViewSet, CheckViewSet, CustomAPIRootView

app_name = "api"

router = DefaultRouter()
router.register(r"access/(?P<endpoint>.+)", AccessViewSet, basename="access")
router.register(r"check/(?P<endpoint>.+)", CheckViewSet, basename="check")

# 替换默认根视图为自定义的
router.APIRootView = CustomAPIRootView

urlpatterns = [
    path("", include(router.urls)),
]

这样API根视图就会显示你手动配置的端点链接，同时原有的API路由功能不受影响。

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