关于 API 排序

[atguigu2018zwuj]

要是 版本 4.5.0 API 可以排序 就好了，目前是无序

[5433zzz]

这样就能排序了
@Autowired
private RequestMappingHandlerMapping requestMappingHandlerMapping;

public static final Map<String, Tag> apiSort = new HashMap<>();

@PostConstruct
public void init() {
    // 获取映射的方法集合
    Map<RequestMappingInfo, HandlerMethod> methodMap = requestMappingHandlerMapping.getHandlerMethods();
    // 遍历方法集合，提取路径模式和方法的映射关系
    methodMap.forEach((key, value) -> {
        io.swagger.v3.oas.annotations.tags.Tag tag = value.getMethod().getDeclaringClass().getAnnotation(io.swagger.v3.oas.annotations.tags.Tag.class);
        if (tag != null) {
            Tag tag1 = new Tag();
            tag1.setName(tag.name());
            tag1.setDescription(tag.description());
            ApiSupport apiSupport = value.getMethod().getDeclaringClass().getAnnotation(ApiSupport.class);
            if (apiSupport != null) {
                tag1.addExtension("x-order", apiSupport.order());
            } else {
                ApiSort apiSort = value.getMethod().getDeclaringClass().getAnnotation(ApiSort.class);
                if (apiSort != null) {
                    tag1.addExtension("x-order", apiSort.value());
                }
            }
            apiSort.put(tag.name(), tag1);
        }
    });
}
@Bean
public GroupedOpenApi merchantApi() {
    return GroupedOpenApi.builder()
            .group("02-merchant")
            .displayName("商家服务")
            .pathsToMatch("/**/merchant/**")
            .addOpenApiCustomizer(new CustomGlobalHeaderCustomizer())
            .build();
}

public static class CustomGlobalHeaderCustomizer implements OpenApiCustomizer {
@OverRide
public void customise(OpenAPI openApi) {
Set tags = new HashSet<>();
// 将全局响应头添加到OpenAPI文档中
Paths paths = openApi.getPaths();
for (Map.Entry<String, PathItem> path : paths.entrySet()) {
PathItem value = path.getValue();
List operations = value.readOperations();
for (Operation operation : operations) {
List parameterList = new ArrayList<>();
List parameters1 = operation.getParameters();
List remove = new ArrayList<>();
if (parameters1 != null) {
for (Parameter parameter : parameters1) {
if (StrUtil.contains(parameter.getSchema().get$ref(), "schemas/Pageable")) {
remove.add(parameter);
parameterList.addAll(pageQueryParameters());
} else if (StrUtil.startWith(parameter.getSchema().get$ref(), "#/components/schemas/")) {
parameterList.addAll(coverParameter(openApi, parameter.getSchema().get$ref()
.replace("#/components/schemas/", "")));
remove.add(parameter);
}
}
if (!parameterList.isEmpty()) {
parameters1.removeAll(remove);
parameterList.addAll(parameters1);
operation.setParameters(parameterList);
}
}
List tagsList = operation.getTags();
if (ToolsUtils.notEmpty(tagsList)) {
for (String tag : tagsList) {
if (apiSort.get(tag) != null) {
tags.add(apiSort.get(tag));
}
}
}
if (!SecurityIgnoringConfig.skipAuthFilter(path.getKey())) {
operation.addSecurityItem(new SecurityRequirement().addList(CommonConstants.HEADER_AUTH));
}
}
}
openApi.setTags(new ArrayList<>(tags));
}
}

public static List<Parameter> coverParameter(OpenAPI openApi, String name) {
    List<Parameter> parameterList = new ArrayList<>();
    Schema schema = openApi.getComponents().getSchemas().get(name);
    if (schema != null) {
        Map<String, Schema> properties = schema.getProperties();
        for (Schema schema1 : properties.values()) {
            Parameter parameter = new Parameter()
                    .name(schema1.getName())
                    .description(schema1.getDescription())
                    .example(schema1.getExample())
                    .in("query")
                    .schema(schema1);
            parameterList.add(parameter);
        }
    }
    return parameterList;
}

public static List<Parameter> pageQueryParameters() {
    List<Parameter> parameterList = new ArrayList<>();
    Parameter schema = new Parameter()
            .name("page")
            .required(true)
            .description("当前页码")
            .in("query")
            .example(1)
            .schema(new IntegerSchema());
    parameterList.add(schema);
    schema = new Parameter()
            .name("size")
            .required(true)
            .description("页面大小")
            .in("query")
            .example(10)
            .schema(new IntegerSchema());
    parameterList.add(schema);
    schema = new Parameter()
            .name("sort")
            .required(false)
            .description("排序标准的格式:属性(,asc|desc)。默认的排序顺序是升序。支持多种排序条件。(test,test2,asc,test3,test4,desc)")
            .in("query")
            .schema(new StringSchema());
    parameterList.add(schema);
    return parameterList;
}

[atguigu2018zwuj]

不生效

[5433zzz]

不生效
你需要在controller上加@tag注解，
io.swagger.v3.oas.annotations.tags.Tag tag = value.getMethod().getDeclaringClass().getAnnotation(io.swagger.v3.oas.annotations.tags.Tag.class);
没有的不会加载。
具体逻辑你可以debug一下看看。

[atguigu2018zwuj]

抽空再研究一下源码吧