.NET7下基于Swagger文件生成ValueTuple代码的疑问

生成结果是否正确？ #

这个生成结果是正确的。Swagger在序列化.NET专属类型时，默认会输出完整的CLR类型标识，包含泛型参数、程序集版本、公钥令牌等信息，目的是让类型能被精准识别，但这种格式可读性极差，不利于后续代码生成和理解。

能否让它更简洁？ #

完全可以，通过调整Swagger的配置，自定义类型的Schema生成逻辑，就能得到更简洁、易读的结果。以下是几种可行的方案：

1. 自定义Swagger Schema过滤器 #

编写一个Schema过滤器，拦截ValueTuple类型的Schema生成，替换为简洁的命名或结构化对象：

public class ValueTupleSchemaFilter : ISchemaFilter
{
    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        var type = context.Type;
        // 处理二元ValueTuple
        if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(ValueTuple<,>))
        {
            // 设置简洁的标题
            var argNames = type.GetGenericArguments().Select(t => t.Name);
            schema.Title = $"ValueTuple<{string.Join(", ", argNames)}>";
            
            // 生成结构化的属性（Item1、Item2）
            schema.Properties.Clear();
            schema.Properties.Add("Item1", context.SchemaGenerator.GenerateSchema(type.GetGenericArguments()[0], context.SchemaRepository));
            schema.Properties.Add("Item2", context.SchemaGenerator.GenerateSchema(type.GetGenericArguments()[1], context.SchemaRepository));
            
            schema.Type = "object";
            schema.AdditionalPropertiesAllowed = false;
        }
        // 可扩展处理三元、四元等更多元的ValueTuple
    }
}

然后在Swagger配置中注册该过滤器：

builder.Services.AddSwaggerGen(c =>
{
    c.SchemaFilter<ValueTupleSchemaFilter>();
});

2. 直接映射特定ValueTuple类型 #

如果你的API中只用到特定类型的ValueTuple，可以直接在Swagger配置中做类型映射：

builder.Services.AddSwaggerGen(c =>
{
    // 映射(string, string)类型
    c.MapType<(string, string)>(() => new OpenApiSchema
    {
        Type = "object",
        Properties = new Dictionary<string, OpenApiSchema>
        {
            ["Item1"] = new OpenApiSchema { Type = "string" },
            ["Item2"] = new OpenApiSchema { Type = "string" }
        },
        AdditionalPropertiesAllowed = false
    });
});

3. 配合代码生成工具优化 #

如果使用NSwag、OpenAPI Generator等代码生成工具，优化后的Schema会被工具识别，生成更贴近目标语言原生的类型（比如C#的原生ValueTuple、Java的Pair类等），进一步提升代码可读性。

内容的提问来源于stack exchange，提问作者Ivan-Mark Debono