You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何在drf-spectacular的Redoc UI中按应用分隔接口?

在drf-spectacular的Redoc UI中按应用分组接口的解决方案

你可以通过自定义SCHEMA_GROUPING分组函数,从接口的operation_id(即你看到的v1_foo_foodcourtrests_des这类名称)中提取应用标识,实现按应用分组展示接口。具体步骤如下:

  1. 配置自定义分组函数路径
    在项目的settings.py中,修改SPECTACULAR_SETTINGS,添加SCHEMA_GROUPING项指向你的自定义函数:
SPECTACULAR_SETTINGS = {
    # 保留你已有的其他配置
    'SCHEMA_GROUPING': 'your_project_name.utils.custom_schema_grouping',
}
  1. 编写自定义分组函数
    在your_project_name/utils.py中创建分组函数,解析operation_id提取应用名作为分组标签:
def custom_schema_grouping(path, method, view):
    # 获取视图对应的operation_id(格式为v1_应用名_xxx)
    operation_id = view.get_view_name().replace(' ', '_').lower()
    parts = operation_id.split('_')
    
    # 按规则拆分出应用名
    if len(parts) >= 3 and parts[0] == 'v1':
        app_name = parts[1].capitalize()
        return f"{app_name} 应用接口"
    # 不符合规则的接口归到默认分组
    return "未分组接口"
  1. 验证效果
    重启Django服务后,打开Redoc UI就能看到接口已经按应用名称分组展示了。

这个方法利用drf-spectacular的分组扩展能力,完全适配你通过operation_id识别应用的场景,不需要修改现有接口的代码结构。

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

相关产品推荐
方舟 Agent Plan

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

最近更新时间:2026.07.31 16:06:41