如何配置Swashbuckle以从文档中省略模板/实体/模式

Question

我试图建立一个过滤器Swashuckle在API留档省略项目的模型/实体/模式，保留控制器。采用的技术是Swashuckle。AspNetCore v3.0.0/SwaggerUIv3.17.1。我已经找到了省略控制器中某个方法的方法，但我想省略留档中的模型。我发现了一个与我类似的问题，包括只隐藏属性。

遵循筛选器代码

public void Apply(OpenApiSchema schema, SchemaFilterContext context)
{
    if (!(context.ApiModel is ApiObject))
    {
        return;
    }

    var model = context as ApiObject;

    if (schema?.Properties == null || model?.ApiProperties == null)
    {
        return;
    }

    var excludedProperties = model.Type
        .GetProperties()
        .Where(
            t => t.GetCustomAttribute<SwaggerExcludeAttribute>() != null
        );

    var excludedSchemaProperties = model.ApiProperties
        .Where(
            ap => excludedProperties.Any(
                pi => pi.Name == ap.MemberInfo.Name
            )
        );

    foreach (var propertyToExclude in excludedSchemaProperties)
    {
         schema.Properties.Remove(propertyToExclude.ApiName);
    }
}

quote：如何配置Swashbuckle以忽略模型上的属性

有没有人建议只隐藏文档中的模型/实体/模式，而不仅仅是它们的属性？如下图所示。

Answer 1

至少对我来说，我必须做这样的事情：

internal class SwaggerSchemaFilter : ISchemaFilter
{
    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        var keys = new System.Collections.Generic.List<string>();
        var prefix = "My.Prefix";
        foreach(var key in context.SchemaRepository.Schemas.Keys)
        {
            if (key.StartsWith(prefix))
            {
                keys.Add(key);
            }
        }

        foreach(var key in keys)
        {
            context.SchemaRepository.Schemas.Remove(key);
        }
    }
}

Answer 2

在您的招摇过市/招摇过市UI配置中，将DefaultModelsExpandDepth设置为-1：

app.UseSwaggerUI(c =>
{
    ...
    c.DefaultModelsExpandDepth(-1);
}