如何在Swagger 3（OpenAPI 3）中按字母顺序排序参数？

你当前配置的springdoc.writer-with-order-by-keys=true仅作用于Schema内部字段的排序，对接口的参数列表排序不生效。要实现参数按字母顺序排列，可通过以下两种方式处理：

一、全局参数排序（所有接口统一按字母排序） #

通过自定义OpenApiCustomizer Bean，遍历所有接口操作并对参数列表按名称字母排序：

@Bean
public OpenApiCustomizer parameterAlphabeticalSortCustomizer() {
    return openApi -> {
        openApi.getPaths().values().forEach(pathItem -> {
            pathItem.readOperations().forEach(operation -> {
                operation.getParameters().sort(Comparator.comparing(Parameter::getName));
            });
        });
    };
}

该配置会自动对所有接口的请求参数按名称字母升序排列，满足你from→jgabsid→to的顺序需求。

二、局部参数排序（指定单个接口的参数顺序） #

如果需要针对特定接口自定义参数顺序，可在@Parameter注解中使用order属性指定优先级（值越小越靠前）：

@GetMapping("/your-api-path")
public ResponseEntity<?> yourApiMethod(
        @Parameter(name = "from", order = 1) String from,
        @Parameter(name = "jgabsid", order = 2) String jgabsid,
        @Parameter(name = "to", order = 3) String to
) {
    // 接口业务逻辑
    return ResponseEntity.ok("success");
}

注意事项 #

• 全局排序配置会覆盖局部的order属性设置，若需保留局部自定义顺序，请勿启用全局排序Bean。
• 你现有配置中的其他属性（如tags-sorter、operations-sorter等）可继续保留，不影响参数排序逻辑。

内容的提问来源于stack exchange，提问作者Octavia