首页 > 其他分享 >Swagger文档折叠了字段描述,很苦恼!

Swagger文档折叠了字段描述,很苦恼!

时间:2024-07-23 11:29:08浏览次数:10  
标签:模型 折叠 配置 接口 文档 Swagger 展开

引言


在SwaggerUI 3.0及之后的版本,文档中的模型显示上,一些简单数据类型的字段描述都被折叠掉了,一眼望去全都是中括号。
image

相比于2.0版本非常不直观。

正文


看了一些解决方案,一些大佬直接嵌入js把折叠展开了,非常的有效果,但少了点优雅。
翻了一些资料发现中间件本身带有一些设置项可以解决问题。

在UseSwaggerUi时有以下配置可以更改界面动作:

DocExpansion配置接口及模型是否要展开。none为全部折叠,list为只展开接口,full为展开接口及模型。

DefaultModelsExpandDepth配置界面下方模型展开深度,就是页面下面的Schema,像我这种一眼都不瞧的人,直接配置成-1,给它隐藏掉。

最重点的配置来了,DefaultModelExpandDepth配置接口内的模型展开深度,设它个5,6,7,8层,就能展开字段描述了。
image

标签:模型,折叠,配置,接口,文档,Swagger,展开
From: https://www.cnblogs.com/jiept/p/18317954

相关文章