SpringBoot3.x与SpringDoc OpenApi之Swagger接口排序

直接使用Swagger之后，发现所有的Controller 接口菜单都是无序的

先看一下效果

 

就是利用了一下 SpringDoc 提供的接口做了一下自定义排序

1.在Controller上加上注解

@Tag(name = "MenuController", description = "1 - 菜单管理")

这里需要注意 description 属性，在下面的代码里面有用到

2.实现自定义排序的接口

@Slf4j
@Component
public class OpenApiLocaleSort implements OpenApiLocaleCustomizer {

    @Override
    public void customise(OpenAPI openApi, Locale locale) {
        List<Tag> tags = openApi.getTags();
        if (CollectionUtil.isNotEmpty(tags)) {
            tags.sort(new Comparator<Tag>() {
                @Override
                public int compare(Tag o1, Tag o2) {
                    if (null == o1 || null == o2) {
                        return 0;
                    }
                    String d1 = o1.getDescription();
                    if (StringUtils.isEmpty(d1) || !d1.contains("-")) {
                        return -1;
                    }
                    String d2 = o2.getDescription();
                    if (StringUtils.isEmpty(d2) || !d2.contains("-")) {
                        return -1;
                    }
                    String[] s1 = d1.split("-");
                    String[] s2 = d2.split("-");
                    try {
                        return Integer.parseInt(s1[0].trim()) > Integer.parseInt(s2[0].trim()) ? 1 : -1;
                    } catch (Exception e) {
                        log.error(e.getMessage(), e);
                    }
                    return 0;
                }
            });
        }
    }
}

这里就是利用 description 属性来进行排序。