drf-spectacular:如何设置自动展开Swagger UI中的字段信息?
解决Swagger UI自动展开字段的配置方案
你可以通过在SPECTACULAR_SETTINGS中添加SWAGGER_UI_SETTINGS配置项,传递Swagger UI的自定义参数来实现自动展开字段的效果,适配你当前使用的drf-spectacular版本(0.24.2):
defaultModelsExpandDepth: 控制模型列表的展开深度,设为-1表示展开所有层级的模型defaultModelExpandDepth: 控制单个模型内部字段的展开深度,设为-1表示完全展开模型的所有字段
修改后的完整配置如下:
SPECTACULAR_SETTINGS = { 'SERVE_INCLUDE_SCHEMA': False, # Permission 'SERVE_AUTHENTICATION': ['rest_framework.authentication.SessionAuthentication'], 'SERVE_PERMISSIONS': ['rest_framework.permissions.IsAuthenticated'], # UI settings 'SWAGGER_UI_DIST': 'SIDECAR', # shorthand to use the sidecar instead 'SWAGGER_UI_FAVICON_HREF': 'SIDECAR', 'REDOC_DIST': 'SIDECAR', 'SCHEMA_PATH_PREFIX_TRIM': True, # 添加Swagger UI自动展开配置 'SWAGGER_UI_SETTINGS': { 'defaultModelsExpandDepth': -1, 'defaultModelExpandDepth': -1 } }
配置完成后重启服务,Swagger UI就会自动展开所有模型及字段信息,达到你想要的效果。
内容的提问来源于stack exchange,提问作者Gilions
相关产品推荐
相关产品推荐

