我正在为我的休息服务使用 Swagger API 文档。我已经成功地将 Swagger 与我的代码集成并且它可以工作。
但我需要格式化 Swagger UI。由于我的项目中响应类的数量很多,所以 Swagger 页面看起来很长,用户必须向下滚动很多才能查看信息。
所以我想折叠我的响应模型类并在用户单击类时展开它。有没有办法做到这一点,如果有的话,必须在哪里进行哪些更改。我尝试编辑 Swagger-UI.js 文件,但无法获得所需的输出。
请让我知道并提前感谢。
我正在为我的休息服务使用 Swagger API 文档。我已经成功地将 Swagger 与我的代码集成并且它可以工作。
但我需要格式化 Swagger UI。由于我的项目中响应类的数量很多,所以 Swagger 页面看起来很长,用户必须向下滚动很多才能查看信息。
所以我想折叠我的响应模型类并在用户单击类时展开它。有没有办法做到这一点,如果有的话,必须在哪里进行哪些更改。我尝试编辑 Swagger-UI.js 文件,但无法获得所需的输出。
请让我知道并提前感谢。
swagger-ui 具有参数 docExpansion(请参阅https://github.com/swagger-api/swagger-ui#parameters)。默认为list
,但如果none
在默认部分中将其设置为src/core/index.js
:
docExpansion: "none"
它会在加载网站时工作并折叠所有内容。
Swagger-UI.js 生成后,通过修改此文件来修改 Swagger UI 将非常困难。
如果您想自定义 SwaggerUI,您应该克隆 github 存储库https://github.com/swagger-api/swagger-ui/然后修改文件并重建它(然后您将获得修改后的 Swagger-UI.js 和所有其他文件)。
Swagger-UI 由不同的视图组成,每个视图都有一个 js 文件和一个车把模板。在您的用例中,我将尝试修改这些文件: