我正在为我的休息服务使用 Swagger API 文档。我已成功将 Swagger 与我的代码集成并且有效。
但是我需要格式化 Swagger UI。由于我的项目中响应类的数量很多,Swagger页面看起来很长,用户必须向下滚动很多才能查看信息。
所以我想折叠我的响应模型类并在用户单击该类时展开它。有没有办法做到这一点,如果可以的话,必须在哪里以及进行哪些更改。我尝试编辑 Swagger-UI.js 文件,但无法实现所需的输出。
请提前告知我并表示感谢。
swagger-ui 有参数 docExpansion。默认为
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文件和一个handlebars模板。 在您的用例中,我将尝试修改这些文件:
要默认折叠 swagger ui,您可以使用:
app = FastAPI(
swagger_ui_parameters = {"docExpansion":"none"},
...
)
对我有用。
swaggerUi.setup(swaggerDocument, false, {docExpansion:"none"})