java - Swagger API 操作排序

Question

如何按字母顺序按方法对我的操作进行排序，例如DELETE、GET、POST、PUT。

我已经阅读了这篇文章，但它是 HTML 格式的，但就我而言，我已将 Swagger 集成到 Spring Boot 中，因此我需要在创建 Docket 时对其进行排序。

Sort API methods in Swagger UI

然后我在Docket中注意到了这个方法operationOrdering()，但是我仍然无法让它工作。

Answer 1

我使用的是 Springfox 2.8.0 版，以下代码片段适用于我记录的 API:

@Bean
UiConfiguration uiConfig() {
    return UiConfigurationBuilder
            .builder()
            .operationsSorter(OperationsSorter.METHOD)

            ...

            .build();
}

有两个可能的值:

• OperationsSorter.ALPHA - 按路径
的字母顺序对 API 端点进行排序
• OperationsSorter.METHOD - 按方法 的字母顺序对 API 端点进行排序

OperationsSorter.METHOD 就是您要查找的内容。

---

替代方法使用operationOrdering():

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
        .select()
        .apis(RequestHandlerSelectors.any())
        .paths(PathSelectors.any())
        .build()

        ...

        .operationOrdering(new Ordering<Operation>() {
            @Override
            public int compare(Operation left, Operation right) {
                return left.getMethod().name().compareTo(right.getMethod().name());
            }
        })
}

但是，这不起作用，因为 Springfox 中的一个错误似乎仍然有效(Operation ordering is not working)。