ASP.NET Core 6 Web API数据库优先模式下元数据注解无效问题

问题原因 #

你用ModelMetadataType配合IgnoreDataMember的方式不生效，是因为Swagger默认不会从ModelMetadataType标记的元数据类中读取序列化/隐藏相关的注解，ModelMetadataType主要服务于MVC的模型验证和数据绑定流程，而非Swagger的Schema生成逻辑。

可行解决方案 #

方案1：使用Swagger专属注解（最直接） #

1. 先安装Swashbuckle的注解包：

Install-Package Swashbuckle.AspNetCore.Annotations

2. 在Program.cs中启用Swagger注解支持：

builder.Services.AddSwaggerGen(c =>
{
    c.EnableAnnotations();
});

3. 修改你的元数据类（注意类名不要用I前缀，这是接口的命名规范，容易混淆）：

// 自动生成的分部类（不要修改这个文件，避免scaffold覆盖）
public partial class Participant
{
    public virtual StudyParticipant? StudyParticipant { get; set; }
}

// 自定义的分部类文件
[ModelMetadataType(typeof(ParticipantMetadata))]
public partial class Participant
{
}

// 元数据类
public class ParticipantMetadata
{
    [SwaggerSchema(Hidden = true)]
    public virtual StudyParticipant? StudyParticipant { get; set; }
}

方案2：自定义SchemaFilter读取元数据类的注解 #

如果不想引入Swagger注解包，可以自己写Filter来识别ModelMetadataType中的IgnoreDataMember：

1. 实现ISchemaFilter：

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

        // 获取模型标记的元数据类型
        var metadataAttr = context.Type.GetCustomAttribute<ModelMetadataTypeAttribute>();
        if (metadataAttr == null) return;

        // 遍历元数据类的属性，检查IgnoreDataMember注解
        foreach (var prop in metadataAttr.MetadataType.GetProperties())
        {
            if (prop.GetCustomAttribute<IgnoreDataMemberAttribute>() != null && schema.Properties.ContainsKey(prop.Name))
            {
                schema.Properties.Remove(prop.Name);
            }
        }
    }
}

2. 在Program.cs注册这个Filter：

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

方案3：直接在分部类中标记JsonIgnore #

因为自动生成的是分部类，你可以在单独的文件中扩展分部类，给导航字段加[JsonIgnore]（Swagger会识别序列化框架的注解）：

// 单独的分部类文件，不会被scaffold覆盖
public partial class Participant
{
    [JsonIgnore]
    public virtual StudyParticipant? StudyParticipant { get; set; }
}

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