如何让实现IDictionary的带实例属性对象在Swashbuckle中作为POCO生成OpenAPI Schema

方案1：自定义Schema过滤器（简单直接） #

搞个自定义的Schema过滤器，强制把你的实体基类及其子类按普通对象处理，把属性都加到Schema里：

using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;
using System.Reflection;

public class EntityDictionarySchemaFilter : ISchemaFilter
{
    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        // 把这里的YourEntityBaseClass换成你实际的实体基类类型
        if (!typeof(YourEntityBaseClass).IsAssignableFrom(context.Type))
            return;

        // 清空Swashbuckle默认给字典生成的空结构
        schema.Properties.Clear();
        schema.Type = "object";
        schema.AdditionalPropertiesAllowed = false;

        // 遍历类型的所有公共实例属性，逐个加到Schema里
        foreach (var property in context.Type.GetProperties(BindingFlags.Public | BindingFlags.Instance))
        {
            // 跳过IDictionary自带的Keys、Values属性，避免冗余
            if (typeof(IDictionary).IsAssignableFrom(context.Type) && 
                (property.Name == "Keys" || property.Name == "Values"))
                continue;

            // 让Swashbuckle自动生成属性对应的Schema
            var propertySchema = context.SchemaGenerator.GenerateSchema(property.PropertyType, context.SchemaRepository);
            schema.Properties[property.Name] = propertySchema;

            // 可选：如果属性是非可空类型，标记为必填
            if (!property.PropertyType.IsNullableType())
            {
                schema.Required.Add(property.Name);
            }
        }
    }
}

// 辅助方法：判断类型是不是可空类型
public static class TypeExtensions
{
    public static bool IsNullableType(this Type type)
    {
        return type.IsGenericType && type.GetGenericTypeDefinition() == typeof(Nullable<>);
    }
}

然后在Program.cs里注册这个过滤器：

builder.Services.AddSwaggerGen(c =>
{
    c.SchemaFilter<EntityDictionarySchemaFilter>();
    // 你的其他Swagger配置...
});

方案2：替换默认的Schema生成器（更彻底） #

要是过滤器不够用，直接换掉Swashbuckle内部的IObjectSchemaGenerator，让它优先识别你的实体类，不用字典解析器处理：

先写自定义的生成器：

using Swashbuckle.AspNetCore.SwaggerGen;
using Microsoft.Extensions.Options;

public class EntityObjectSchemaGenerator : ObjectSchemaGenerator
{
    public EntityObjectSchemaGenerator(ISchemaGenerator schemaGenerator, IOptions<SwaggerGenOptions> options) 
        : base(schemaGenerator, options)
    {
    }

    protected override bool ShouldGenerateAsDictionary(Type type)
    {
        // 只要是继承自你的实体基类的类型，都不按字典生成
        if (typeof(YourEntityBaseClass).IsAssignableFrom(type))
            return false;

        // 其他类型保持原来的逻辑
        return base.ShouldGenerateAsDictionary(type);
    }
}

然后在Program.cs里替换DI容器里的实现：

builder.Services.AddSwaggerGen();

// 把默认的ObjectSchemaGenerator换成我们自定义的
builder.Services.Replace(ServiceDescriptor.Transient<IObjectSchemaGenerator, EntityObjectSchemaGenerator>());

注意事项 #

• 方案1上手快，直接修正已经生成的Schema；方案2从根源上改判断逻辑，避免字典解析器被触发；
• 两种方案都不用动基类的IDictionary<,>接口，不会影响系统其他功能；
• 记得把代码里的YourEntityBaseClass换成你实际的实体基类类型。

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