有没有可以让我在Swagger UI中显示文档的虚拟操作?

时间:2018-09-24 11:42:25

标签: swagger swagger-ui

我正在寻找一个在整个“描述”字段中包含大量信息的API。我们正在谈论一个目录和多个部分。真正详细而广泛的文档。目前尚不能使用docs的外部网站,所以我认为这很有意义。

在Swagger UI中,这在用户点击API定义之前显示为很多文本。太多的滚动无法获得良好的用户体验。

改善用户体验是我的主要目标,API运行良好(为新用户浏览文档是一种痛苦。)

我希望使用https://github.com/jensoleg/swagger-ui作为改善这种体验的一部分。

我认为我可以通过创建“ documentation”标签并将文档分成几部分来解决自己的问题,就像单独进行操作一样。 它在一定程度上有效,操作说明字段使文档可以完美显示,但这是通过替换实际操作中的内容(显然不是最终解决方案)来完成的。

enter image description here

那么是否有一种虚拟或不活动的操作类型可以使我将文档组作为Swagger UI展开菜单的一部分? 还是有更好的方法来实现这一目标?

0 个答案:

没有答案