How to configure Swashbuckle to ignore property on model

Question

I'm using Swashbuckle to generate swagger documentation\UI for a webapi2 project. Our models are shared with some legacy interfaces so there are a couple of properties I want to ignore on the models. I can't use JsonIgnore attribute because the legacy interfaces also need to serialize to JSON so I don't want to ignore the properties globally, just in the Swashbuckle configuration.

I found a method of doing this documented here:

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

But this appears to be out of date with the current Swashbuckle release.

The method recommended for the old version of Swashbuckle is using an IModelFilter implementation as follows:

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>()); 

But I'm unsure how to configure Swashbuckle to use the IModelFilter in the current version? I'm using Swashbuckle 5.5.3.

Answer 1

If you need to do this but without using JsonIgnore (maybe you still need to serialize/deserialize the property) then just create a custom attribute.

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

Then a schema filter similar to Johng's

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 } 

Don't forget to register the filter

c.SchemaFilter<SwaggerExcludeFilter>();