Django项目中allauth-headless接口未生成Swagger文档求助
路由未被spectacular扫描到
确认项目urls.py中已正确引入allauth-headless的路由,且这些路由没有被放在条件分支(如仅非DEBUG环境加载)中。同时检查settings.py的SPECTACULAR_SETTINGS,确保EXCLUDE_PATHS没有排除allauth-headless的路由路径。视图缺少Schema标记
drf-spectacular需要视图类带有@extend_schema装饰器或相关Schema混入才能生成文档。allauth-headless作为新发布的库,可能暂未内置对drf-spectacular的支持,导致其视图没有对应的标记。这种情况可以通过继承原视图并手动添加@extend_schema装饰器,或者编写自定义schema钩子来适配。版本兼容问题
检查django-allauth、allauth-headless、drf-spectacular及DRF的版本是否匹配。allauth-headless是新库,可能需要搭配drf-spectacular的最新版本才能正确识别其视图结构。配置排除了目标视图
查看SPECTACULAR_SETTINGS中的EXCLUDE_VIEWS或EXCLUDE配置项,确认是否误将allauth-headless的视图类或路径排除在外,导致spectacular跳过这些接口的文档生成。需手动补充Schema定义
如果以上排查都没问题,可能需要手动为allauth-headless的接口添加schema。可以在SPECTACULAR_SETTINGS中通过APPEND_SCHEMA或自定义PREPROCESSING_HOOKS来补充接口的schema信息;同时确认spectacular_sidecar静态资源已正确安装并加载,保证Swagger UI能渲染新增的文档。
内容的提问来源于stack exchange,提问作者Harm

