折叠/展开Swagger响应模型类

时间:2014-02-25 08:27:21

标签: javascript jquery swagger swagger-ui

我使用Swagger API文档进行休息服务。我已经成功地将Swagger与我的代码集成在一起,它可以工作。

但我要求格式化Swagger UI。由于我的项目中响应类的数量很多,因此Swagger页面看起来非常冗长,用户必须向下滚动才能查看信息。

所以我想折叠我的响应模型类,并在用户单击该类时展开它。有没有办法做到这一点,如果有的话,在哪里和必须做出哪些改变。我尝试编辑Swagger-UI.js文件,但无法实现所需的输出。

请提前告知我并提前致谢。

2 个答案:

答案 0 :(得分:0)

生成Swagger-UI.js,通过修改此文件来修改Swagger UI非常困难。

如果要自定义SwaggerUI,您应该克隆github存储库https://github.com/swagger-api/swagger-ui/,然后修改文件并重建它(然后您将获得修改后的Swagger-UI.js和所有其他文件)。

Swagger-UI由不同的视图组成,每个视图都有一个js文件和一个把手模板。 在您的用例中,我将尝试修改这些文件:

  • 的src /主/模板/ signature.handlebars
  • 的src /主/ JavaScript的/视图/ SignatureView.js

答案 1 :(得分:0)

swagger-ui具有参数docExpansion(请参阅https://github.com/swagger-api/swagger-ui#parameters)。默认值为sbt ,但如果在list的默认值部分中将其设置为none

src/core/index.js

在加载网站时它会工作并崩溃。