Exclude properties in your Swagger OpenAPI metadata

.NET (core) has OpenAPI support through Swashbuckle, a NuGet package that generates OpenAPI metadata based on your API controllers.

I was asked to manipulate the Swagger metadata to exclude a specific property from the document metadata.

I found 2 possible solutions to achieve this goal:

Option 1 – Add a JsonIgnore attribute on your object:

	public class Product
	{
	[JsonIgnore]
	public int Id {get;set;}
	public string Name {get;set;}
	}

view raw Product.cs hosted with ❤ by GitHub

Option 2 – Create a SchemaFilter:

	public class SwaggerIdFilter : ISchemaFilter
	{
	public void Apply(Schema model, SchemaFilterContext context)
	{
	model.Properties.Remove("id");
	}
	}

view raw SwaggerIdFilter.cs hosted with ❤ by GitHub

Don’t forget to register the filter in your Swagger configuration:

	httpConfiguration
	.EnableSwagger(c =>
	{
	c.SchemaFilter<SwaggerIdFilter>();
	});

view raw WebApiConfig.cs hosted with ❤ by GitHub