swagger - 如何编写自定义排序器以在 UI 中按名称对 springdoc swagger 标签进行排序？

Question

我正在使用最新版本 (1.3.0) 的 springdoc-openapi。现在我要按“名称”在 UI 中对我的标签进行排序 属性(property)。

我知道“springdoc.swagger-ui.tagsSorter”配置，并且我可以使用自定义排序器功能。但是我找不到函数应该是什么样子的例子。

我尝试了以下似乎不起作用的方法:

springdoc.swagger-ui.tagsSorter=(a, b) => a.get("name").localeCompare(b.get("name"))

Answer 1

默认情况下，您可以按字母顺序对标签进行排序:

https://springdoc.org/faq.html#how-can-i-sort-endpoints-alphabetically

您可以使用 OpenApiCustomiser 控制标签顺序并定义您自己的比较器:

@Bean
public OpenApiCustomiser sortTagsAlphabetically() {
    return openApi -> openApi.setTags(openApi.getTags()
            .stream()
            .sorted(Comparator.comparing(tag -> StringUtils.stripAccents(tag.getName())))
            .collect(Collectors.toList()));
}