Django执行generateschema命令忽略users相关URL问题求解

• 优先检查users应用下视图的装饰器配置：DRF自带的默认Schema生成器只会识别使用@api_view装饰的函数视图，或者继承自APIView、ViewSet的类视图。如果你的views.login、views.registerUser是普通Django函数视图，未添加DRF的相关装饰器，就不会被纳入生成的Schema中。可对比networkController下的views.startNetwork，该视图能被正常识别，说明其已经配置了正确的DRF装饰器。
• 检查视图的请求方法配置：如果@api_view装饰器未明确指定允许的请求方法，或类视图未配置http_method_names属性，也可能导致Schema生成器识别异常，建议登录、注册这类接口明确指定允许POST请求，示例为@api_view(['POST'])。
• 检查Schema生成的权限过滤逻辑：默认get_schema_view会沿用当前请求用户的权限规则扫描接口，如果你的users接口配置了登录校验类的权限控制，而生成Schema时使用的是匿名用户身份，相关接口会被权限规则过滤掉，不会出现在Schema中。可临时调整get_schema_view的权限类为公开访问测试：

from rest_framework.permissions import AllowAny

path('api/', get_schema_view(
    title="API Documentation",
    description="API for all things",
    permission_classes=[AllowAny]
), name='openapi-schema')

方法1：修复视图装饰器后使用默认生成器 #

给users下的两个视图添加@api_view装饰器即可，示例代码：

# users/views.py
from rest_framework.decorators import api_view
from rest_framework.response import Response

@api_view(['POST'])
def login(request):
    # 保留原有业务逻辑不变
    return Response(...)

@api_view(['POST'])
def registerUser(request):
    # 保留原有业务逻辑不变
    return Response(...)

修改完成后重新执行生成命令：
./manage.py generateschema --file schema.yml

方法2：替换为DRF官方推荐的drf-spectacular生成Schema #

如果默认生成器仍存在识别问题，可使用功能更完善、兼容性更强的drf-spectacular工具生成OpenAPI Schema，操作步骤如下：

1. 安装依赖：
   pip install drf-spectacular
2. 修改Django项目的settings.py配置：

INSTALLED_APPS = [
    # 保留原有其他应用，新增以下两个应用
    'rest_framework',
    'drf_spectacular',
]

REST_FRAMEWORK = {
    # 配置默认Schema类
    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
}

3. 新增路由（可选，用于在线查看接口文档）：

from drf_spectacular.views import SpectacularAPIView, SpectacularSwaggerView

urlpatterns = [
    # 保留原有其他路由，新增以下两个路由
    path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
    path('api/docs/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
]

4. 生成Schema文件命令：
   ./manage.py spectacular --file schema.yml

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