Swashbuckle.AspNetCore 中保持属性名称大小写的方法

在使用 Swashbuckle.AspNetCore 生成 API 文档时，默认情况下会将模型属性名称转换为小驼峰式(camelCase)命名法。但有时我们需要保持与 C# 代码中完全一致的属性名称大小写格式。本文将介绍如何实现这一需求。

问题背景

在 .NET Web API 项目中，当我们使用 Swashbuckle.AspNetCore 生成 Swagger/OpenAPI 文档时，默认情况下模型属性名称会被自动转换为小驼峰式命名法。例如：

public class TestModel
{
    public int MyProperty1 { get; set; }
    public int MyProperty2 { get; set; }
    public int MyProperty3 { get; set; }
}

生成的 Swagger 文档中会显示为：

"properties": {
  "myProperty1": {
    "type": "integer",
    "format": "int32"
  },
  // 其他属性...
}

解决方案

要保留原始的属性名称大小写格式，我们需要配置 JSON 序列化选项。具体方法如下：

方法一：配置 JSON 序列化选项

在 .NET Core/5/6/7/8 中，可以在 Program.cs 或 Startup.cs 文件中添加以下配置：

builder.Services.AddControllers()
    .AddJsonOptions(opt => opt.JsonSerializerOptions.PropertyNamingPolicy = null);

这个设置会禁用默认的属性名称转换策略，保持与 C# 代码中完全一致的属性名称。

方法二：使用 Schema 过滤器

如果需要更精细的控制，可以使用 Swashbuckle 的 Schema 过滤器来自定义属性名称：

public class KeepOriginalNameSchemaFilter : ISchemaFilter
{
    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        if (schema.Properties == null)
        {
            return;
        }

        var newProperties = new Dictionary<string, OpenApiSchema>();
        foreach (var property in schema.Properties)
        {
            // 保持原始属性名称
            newProperties[property.Key] = property.Value;
        }
        schema.Properties = newProperties;
    }
}

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

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

注意事项

1. 保持原始属性名称可能会影响客户端代码的生成，特别是使用某些 JavaScript 框架时，因为它们通常期望小驼峰式命名法。

2. 如果 API 需要同时支持多种命名约定，可以考虑使用自定义的命名策略或提供多个版本的 API 文档。

3. 在 .NET 中，System.Text.Json 默认不提供 PascalCase 命名策略，如果需要这种格式，需要自行实现或使用第三方库。

通过以上方法，我们可以灵活控制 Swagger 文档中属性名称的显示格式，满足不同场景下的需求。