Swagger-UI中的排序API方法

我找不到任何有效的示例,说明如何实现以下目标:我希望Swagger-UI中的API方法按方法(GET-POST-PUT-DELETE)或/和字母顺序排序。

到目前为止,所有方法都以随机顺序显示,甚至没有按照我的源代码给出的顺序显示。

我使用Jax-RS + Jersey 1。

对我来说,使用@ApiOperation的position属性进行排序不是一种选择,因为方法太多,而且API仍在扩展,因此如果有一个新方法,我将需要全部更新。

有什么提示吗?

回答:

sorter参数已分为两个参数,如Fix

1040,Fix

1280中所述:

apisSorter

对API /标签列表进行排序。它可以是“

alpha”(按名称排序)或一个函数(请参阅Array.prototype.sort()了解排序函数的工作原理)。默认为服务器返回的顺序不变。

操作员

对每个API的操作列表进行排序。它可以是“ alpha”(按字母数字顺序按路径排序),“

method”(按HTTP方法排序)或一个函数(请参阅Array.prototype.sort()了解排序函数的工作原理)。默认为服务器返回的顺序不变。

因此,您需要更新sorterapisSorter按字母顺序对API列表进行排序,和/或operationsSorter对每个API的操作列表进行排序。宠物店演示已更新为apisSorter,如下所示:

示例:(工作演示,按字母顺序排序)

window.swaggerUi = new SwaggerUi({

...

apisSorter : "alpha"

});

sorter参数仍然与旧版本的Swagger UI相关:

您可以使用 分拣机 实例SwaggerUi时参数。这发生在Swagger-Ui

index.html上的javascript中。从文档中:

分类器对API列表进行排序。它可以是“ ”(按字母数字顺序对路径进行排序)或“

”(通过HTTP方法进行排序操作)。默认值为服务器返回的顺序不变。

范例:

window.swaggerUi = new SwaggerUi({

...

sorter : "alpha"

});

以上是 Swagger-UI中的排序API方法 的全部内容, 来源链接: utcz.com/qa/435512.html

回到顶部