window.swaggerUi = new SwaggerUi({
...
apisSorter: "alpha", // can also be a function
operationsSorter : "method", // can also be 'alpha' or a function
});
apisSorter: "alpha",
operationsSorter: function (a, b) {
var order = { 'get': '0', 'patch': '1', 'post': '2'};
return order[a._root.entries[1][1]].localeCompare(order[b._root.entries[1][1]]);
}
9条答案
按热度按时间t1qtbnec1#
Swagger UI 2.1.0+的更新:
sorter
参数已拆分为两个参数,如Fix 1040、Fix 1280中所述:Apis分类器
对API/标记列表应用排序。它可以是'alpha'(按名称排序)或函数(请参阅Array.prototype.sort()了解排序函数如何工作)。默认为服务器返回的顺序不变。
操作排序器
对每个API的操作列表应用排序。它可以是'alpha'(按路径字母数字排序)、'method'(按HTTP方法排序)或函数(请参阅Array.prototype.sort()了解排序函数的工作原理)。默认为服务器返回的顺序不变。
因此,您需要将
sorter
更新为apisSorter
,以便按字母顺序对API列表进行排序,和/或将operationsSorter
更新为每个API的操作列表进行排序。pet shop演示已更新为apisSorter,如下所示:Example:(working demo,按字母顺序排序)
对于2.1.0之前的Swagger UI版本:
sorter
参数仍然与旧版本的Swagger UI相关:示例化SwaggerUi时,可以使用 sorter 参数。这在Swagger-Ui index.html上的javascript中进行。从文档中:
排序程序对API列表应用排序。它可以是'alpha'(按字母数字顺序排序路径)或'method'(按HTTP方法排序操作)。默认值是服务器返回的未更改顺序。
Example:
uqjltbpv2#
可接受的答案有点过时。在较新的版本中,它是由以下人员完成的:
csga3l583#
我遇到了同样的问题,我这样解决了它
jjjwad0x4#
针对Swagger 3.18.3的更新
92dk7w1h5#
针对3.x+的更新
正如前面的评论中提到的,
apisSorter
似乎在v. 3.x中被重命名为tagsSorter
,请参见Swagger configuration documentation。du7egjpx6#
对于使用SwaggerUI3的.net核心用户:
kdfy810k7#
对于遇到同样问题的Python用户,以下是解决方法
使用闪光器v0.9.5(=Swagger-UI 3.28.0)和 flask v2.0.1:
ars1skjm8#
用我的昂首阔步版本我已经设法这样做:
jm2pwxwz9#
要对nestjs中的api标记和操作进行排序,可以按以下方式将SwaggerCustomOptions传递给
SwaggerModule.setup()
方法: