折叠/展开Swagger响应模型类

5kgi1eie  于 2022-11-06  发布在  其他
关注(0)|答案(3)|浏览(350)

我正在使用Swagger API文档为我的其余服务。我已经成功地将Swagger与我的代码集成,它的工作。
但是我有一个要求来格式化Swagger UI。由于我的项目中响应类的数量很多,Swagger页面看起来很长,用户必须向下滚动很多才能查看信息。
所以我想折叠我的响应模型类,并在用户点击该类时展开它。有没有办法做到这一点?如果有,在哪里和什么地方必须作出改变。我试图编辑Swagger-UI.js文件,但我不能获得所需的输出。
请让我知道,并提前感谢。

xzlaal3s

xzlaal3s1#

swagger-ui具有参数docExpansion(请参阅https://github.com/swagger-api/swagger-ui#parameters)。预设值为list,但如果在src/core/index.js的预设值区段中将其设定为none
docExpansion: "none"
它将工作并在加载站点时折叠所有内容。

fkaflof6

fkaflof62#

如果生成Swagger-UI.js,则很难通过修改此文件来修改Swagger UI。
如果你想自定义SwaggerUI,你应该克隆github仓库https://github.com/swagger-api/swagger-ui/,然后修改文件并重建它(你将得到一个修改后的Swagger-UI.js和所有其他文件)。
Swagger-UI由不同的视图组成,每个视图都有一个js文件和一个手柄模板。

  • 源代码/main/模板/签名. handbars
  • src/main/javascript/view/SignatureView.js
owfi6suc

owfi6suc3#

要在默认情况下折叠swagger ui,可以用途:

app = FastAPI(
swagger_ui_parameters = {"docExpansion":"none"},
...
)

相关问题