java - 在 Swagger-UI 中对 API 方法进行排序

Question

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

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

我使用 Jax-RS + Jersey 1。

使用@ApiOperation 的位置属性排序对我来说不是一个选项，因为方法太多而且 API 仍在扩展，所以如果有新方法我需要更新所有。

有什么提示吗？

Answer 1

Swagger UI 2.1.0+ 的更新:sorter 参数已拆分为两个参数，如 Fix 1040 中所述, Fix 1280 :

apisSorter

Apply a sort to the API/tags list. It can be 'alpha' (sort by name) or a function (see Array.prototype.sort() to know how sort function works). Default is the order returned by the server unchanged.

operationsSorter

Apply a sort to the operation list of each API. It can be 'alpha' (sort by paths alphanumerically), 'method' (sort by HTTP method) or a function (see Array.prototype.sort() to know how sort function works). Default is the order returned by the server unchanged.

因此，您需要将 sorter 更新为 apisSorter 以按字母顺序对 API 列表进行排序，和/或将 operationsSorter 更新为对操作列表进行排序每个API。宠物店demo更新为apiSorter，如下图:

Example : ( working demo , 按字母顺序排序)

window.swaggerUi = new SwaggerUi({

...

apisSorter : "alpha"
});

对于 2.1.0 之前的 Swagger UI 版本:

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

您可以在实例化 SwaggerUi 时使用 sorter 参数。这发生在 Swagger-Ui index.html 上的 javascript 中。来自documentation :

sorter apply a sort to the API list. It can be 'alpha' (sort paths alphanumerically) or 'method' (sort operations by HTTP method). Default is the order returned by the server unchanged.

Example :

window.swaggerUi = new SwaggerUi({

...

sorter : "alpha"
});