How do I write a custom sorter to sort my springdoc swagger tags by name in the UI?

Question

I am using springdoc-openapi with the latest version (1.3.0). Now I would like sort my tags in the UI by "name" property.

I know about the "springdoc.swagger-ui.tagsSorter" configuration and that I can use a custom sorter function. But I cannot find examples how the function should look like.

I tried the following which does not seem to work:

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

user_1133021 · Answer

By default, you can sort tags alphabetically:

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

You can have control on the tags order, using OpenApiCustomiser and define your own Comparator:

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

user_870834 · Answer

With reference from @brianbro's answer, as suggested at https://springdoc.org/faq.html#how-can-i-sort-endpoints-alphabetically

I added

@Tag(name="1. Admin endpoints")

@Tag(name = "2. Everyone's enpoints!")

and below prop to application.yml :

springdoc.swagger-ui.tagsSorter=alpha

And can see them sorted according to numbering on my swagger UI.

How do I write a custom sorter to sort my springdoc swagger tags by name in the UI?

2 Answers