NSwag v14.3.0 版本中可选参数顺序问题的分析与解决

在最新的 NSwag v14.3.0 版本中，开发者们发现了一个影响客户端代码生成的严重问题：通过 OperationProcessor 添加的可选参数被错误地放置在必需参数之前，这直接导致了生成的 C# 和 TypeScript 客户端代码无法通过编译。

问题现象

当开发者使用 OperationProcessor 向 API 操作添加可选参数时，这些参数在生成的客户端代码中被错误地排列在必需参数之前。例如，一个原本应该生成如下的接口：

public partial interface IWeatherForecastApi
{
    System.Threading.Tasks.Task<WeatherForecast> GetByIdAsync(
        System.Guid cityId, 
        string optionalParam = null, 
        System.Threading.CancellationToken cancellationToken = default);
}

在 v14.3.0 中却生成了错误的顺序：

public partial interface IWeatherForecastApi
{
    System.Threading.Tasks.Task<WeatherForecast> GetByIdAsync(
        string optionalParam = null, 
        System.Guid cityId, 
        System.Threading.CancellationToken cancellationToken = default);
}

这种参数顺序错误会导致 C# 编译器报错 CS1737（可选参数不能出现在必需参数之前），同时也影响了 TypeScript 客户端的生成。

问题根源

经过深入分析，发现问题源于 v14.3.0 版本中对 CSharpOperationModel.cs 文件的修改。开发者将原有的集合初始化方式改为了新的集合表达式语法：

v14.2.0 的正确实现：

Parameters = new List<CSharpParameterModel>(
    operation.Parameters
        .Where(p => p.Kind != OpenApiParameterKind.Body)
        .Select(p => new CSharpParameterModel(p.Name, ...))
    .Concat(bodyParameters)
    .ToList();

v14.3.0 的错误实现：

Parameters = [
    ..operation.Parameters
        .Where(p => p.Kind != OpenApiParameterKind.Body)
        .Select(p => new CSharpParameterModel(p.Name, ...)),
    ..bodyParameters
];

虽然集合表达式语法更简洁，但它意外地改变了参数的排序逻辑，导致可选参数被错误地前置。

解决方案

项目维护团队迅速响应，在后续版本中修复了这个问题。开发者可以通过以下方式解决：

1. 暂时回退到 v14.2.0 版本
2. 使用预览版本 14.3.1-preview-20250420-0810 或更高版本
3. 等待官方发布正式修复版本

最佳实践建议

为了避免类似问题，建议开发者在升级 NSwag 版本时：

1. 始终在开发环境中先测试新版本
2. 建立客户端代码生成的自动化测试
3. 关注项目的变更日志和已知问题
4. 对于关键项目，考虑锁定特定版本

这个问题的出现提醒我们，即使是语法糖式的改进也可能带来意想不到的副作用，特别是在处理复杂逻辑如参数排序时。作为开发者，我们需要在追求代码简洁性的同时，保持对功能正确性的高度关注。