如何配置Swashuckle忽略模型上的属性

Question

我正在使用Swashback为webapi2项目生成swagger documentation\UI。我们的模型与一些遗留接口共享，因此我想忽略模型上的几个属性。我不能使用JsonIgnore属性，因为遗留接口还需要序列化为JSON，所以我不想全局忽略属性，只是在Swashback配置中。

我在这里找到了这样做的方法：

https://github.com/domaindrivendev/Swashbuckle/issues/73

但这似乎已经过时，与目前的虚张声势释放。

为旧版本的Swashuckle推荐的方法是使用IModelFilter实现，如下所示：

public class OmitIgnoredProperties : IModelFilter
{
    public void Apply(DataType model, DataTypeRegistry dataTypeRegistry, Type type)
    {
        var ignoredProperties = … // use reflection to find any properties on 
                                  // type decorated with the ignore attributes

        foreach (var prop in ignoredProperties) 
            model.Properties.Remove(prop.Name);

    }
}

SwaggerSpecConfig.Customize(c => c.ModelFilter<OmitIgnoredProperties>());

但我不确定如何配置Swashback以在当前版本中使用IModelFilter？我用的是Swashback 5.5.3。

Answer 1

解决方案。NET Core 3.1和。净标准2.1：

使用系统中的JsonIgnore。文本Json。序列化命名空间。

（Newtonsoft.Json中的JsonIgnore将不起作用）

public class Test
{
    [System.Text.Json.Serialization.JsonIgnore]
    public int HiddenProperty { get; set; }
    public int VisibleProperty { get; set; }
}

Answer 2

如果您将字段/属性标记为内部的或protected的或私有的，它将被swagger留档中的swashbnle自动忽略。更新：显然，这些属性/字段不会在请求/响应中填充。

Answer 3

如果需要这样做，但不使用JsonIgnore（可能仍然需要序列化/反序列化属性），那么只需创建一个自定义属性。

[AttributeUsage(AttributeTargets.Property)]
public class SwaggerExcludeAttribute : Attribute
{
}

然后是一个类似于Johng的模式过滤器

public class SwaggerExcludeFilter : ISchemaFilter
{
    #region ISchemaFilter Members

    public void Apply(Schema schema, SchemaRegistry schemaRegistry, Type type)
    {
        if (schema?.properties == null || type == null)
            return;

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

        foreach (var excludedProperty in excludedProperties)
        {
            if (schema.properties.ContainsKey(excludedProperty.Name))
                schema.properties.Remove(excludedProperty.Name);
        }
    }

    #endregion
}

别忘了注册过滤器

c.SchemaFilter<SwaggerExcludeFilter>();