如何在drf_spectacular中像drf_yasg一样显示operation_id?
在drf_spectacular中显示operation_id的方法
要让drf_spectacular的Swagger UI像drf_yasg那样显示operation_id,只需在项目的settings.py中添加如下配置,开启Swagger UI的displayOperationId选项:
SPECTACULAR_SETTINGS = { 'SWAGGER_UI_SETTINGS': { 'displayOperationId': True, # 可添加其他Swagger UI配置项,比如接口排序、模型展开深度等 }, # 其他drf_spectacular相关配置 }
配置完成后重启服务,Swagger UI的每个接口条目旁就会显示对应的operation_id了。
如果需要自定义operation_id的生成规则,还可以通过以下方式调整:
- 单个接口自定义:在视图函数上使用
@extend_schema(operation_id="自定义ID")指定 - 全局自定义:修改
SPECTACULAR_SETTINGS中的OPERATION_ID_GENERATOR,指定自定义的生成器函数
内容的提问来源于stack exchange,提问作者creyD
相关产品推荐
相关产品推荐

