Ignore Property From Swagger UI

Question

I'm trying to ignore property on swagger UI. based on this article I have implemented a Filter and tried

[AttributeUsage(AttributeTargets.Property, AllowMultiple = true)]
public class SwaggerExcludeAttribute : Attribute
{
}

public class SwaggerExcludeFilter : ISchemaFilter
{
    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        if (schema?.Properties == null || context == null) return;
        var excludedProperties = context.Type.GetProperties()
            .Where(t => t.GetCustomAttribute(typeof(SwaggerExcludeAttribute), true) != null);
        foreach (var excludedProperty in excludedProperties)
        {
            if (schema.Properties.ContainsKey(excludedProperty.Name))
                schema.Properties.Remove(excludedProperty.Name);
        }
    }
}

custom attribute seems not properly getting by reflection excludedProperties always empty.
context.MemberInfo does read the property but cannot remove from schema.Properties because no properties there

my sample model is like

public class SequenceSetupListModel
{
    public int Id { get; set; }
    public int Sequence { get; set; }
    public string Role { get; set; }
    public string User { get; set; }
    [SwaggerExclude]
    public IList<Sequence> SequenceLists { get; set; }
}

What I'm missing here

Regards

How do you use this model? It is for response or request? – Roman Marusyk Mar 24 '20 at 18:40 — Roman Marusyk, Mar 24 '20 at 18:40
@RomanMarusyk I'm using for request. for one of post method – Gayan Mar 24 '20 at 18:44 — Gayan, Mar 24 '20 at 18:44

score 7 · Answer 1 · answered Jan 05 '21 at 23:20

7

If you mark the property as internal instead of public then it will be ignored by Swashbuckle.

answered Jan 05 '21 at 23:20

IronSean

1,520
17
31

Hossein Babamoradi · Answer 2 · 2021-02-13T19:28:26.540

[JsonIgnore] will just ignore property if the way of model binding is [FromBody] and it does not work for [FromQuery] and [FromForm] use this filter to ignore properties in all binding way

 public class IgnorePropertyFilter : IOperationFilter
{
    public void Apply(OpenApiOperation operation, OperationFilterContext context)
    {
        if (context.ApiDescription == null || operation.Parameters == null)
            return;

        if (!context.ApiDescription.ParameterDescriptions.Any())
            return;

        
        context.ApiDescription.ParameterDescriptions.Where(p => p.Source.Equals(BindingSource.Form)
                    && p.CustomAttributes().Any(p => p.GetType().Equals(typeof(JsonIgnoreAttribute))))
            .ForAll(p => operation.RequestBody.Content.Values.Single(v => v.Schema.Properties.Remove(p.Name)));



        context.ApiDescription.ParameterDescriptions.Where(p => p.Source.Equals(BindingSource.Query)
                      && p.CustomAttributes().Any(p => p.GetType().Equals(typeof(JsonIgnoreAttribute))))
            .ForAll(p => operation.Parameters.Remove(operation.Parameters.Single(w => w.Name.Equals(p.Name))));


        #region OldCode

        //var excludedProperties = context.ApiDescription.ParameterDescriptions.Where(p =>
        //    p.Source.Equals(BindingSource.Form));

        //if (excludedProperties.Any())
        //{

        //    foreach (var excludedPropertie in excludedProperties)
        //    {
        //        foreach (var customAttribute in excludedPropertie.CustomAttributes())
        //        {
        //            if (customAttribute.GetType() == typeof(JsonIgnoreAttribute))
        //            {
        //                for (int i = 0; i < operation.RequestBody.Content.Values.Count; i++)
        //                {
        //                    for (int j = 0; j < operation.RequestBody.Content.Values.ElementAt(i).Encoding.Count; j++)
        //                    {
        //                        if (operation.RequestBody.Content.Values.ElementAt(i).Encoding.ElementAt(j).Key ==
        //                            excludedPropertie.Name)
        //                        {
        //                            operation.RequestBody.Content.Values.ElementAt(i).Encoding
        //                                .Remove(operation.RequestBody.Content.Values.ElementAt(i).Encoding
        //                                    .ElementAt(j));
        //                            operation.RequestBody.Content.Values.ElementAt(i).Schema.Properties.Remove(excludedPropertie.Name);


        //                        }
        //                    }
        //                }

        //            }
        //        }
        //    }

        //}


        #endregion
    }
}

in startup

services.AddSwaggerGen(options =>
{
    options.OperationFilter<IgnorePropertyFilter>();
});

now [JsonIgnore] will work in all model binding

in this namespace AutoMapper.Internal or you can use foreach loop — Hossein Babamoradi, Feb 11 '21 at 21:52
Ah... we aren't using Automapper for some reason. I had tried ToList().ForEach() but that threw an exception so I gave up... I'll have to try it again after my vacation. — CodeRedick, Feb 12 '21 at 05:37

score 3 · Accepted Answer · answered Mar 24 '20 at 18:51

3

You don't actually need to define own attribute for request models. If you are using Json.NET then use [JsonIgnore]

answered Mar 24 '20 at 18:51

Roman Marusyk

23,328
24
73
116

Yes i know that but i just want to know why this is not working – Gayan Mar 24 '20 at 18:59
I'm using 5.2.1 – Gayan Mar 24 '20 at 19:39
Why do you think that your code doesn't work? `excludedProperties ` can be empty for some controllers. Just run it without debugging and see if `SequenceLists ` is still in Swagger. Your code works well in my default project – Roman Marusyk Mar 24 '20 at 19:58
it didn't work. it shows. I'm wondering how it works on you? – Gayan Mar 24 '20 at 21:33
Are U sure that your code is the same as in the question? You wrote: "context.MemberInfo does read" but there is no such code. Show the screen of your model in swagger – Roman Marusyk Mar 24 '20 at 21:45
it does anyway i gave up i'm going with JsonIgnore thanks for the answer – Gayan Mar 25 '20 at 06:06
This means you can't send the property with a json post request – jjxtra Apr 11 '23 at 15:32

score 2 · Answer 4 · answered Aug 27 '20 at 13:27

2

To all who are wondering why [JsonIgnore] isn't working, its because you cannot use the Newtonsoft library version on .net core 3.x. You need to use the System.Text.Json nuget package. https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/README.md#systemtextjson-stj-vs-newtonsoft

answered Aug 27 '20 at 13:27

JustPassingBy

21
1

You can use the Newtonsoft library on .NET Core 3.x – fix Mar 15 '22 at 18:26

score 2 · Answer 5 · answered Nov 23 '20 at 06:11

2

There is the [OpenApiIgnore] attribute in the NSwag.Annotations namespace for AspNetCore. It appears to work on a class or a method and excludes them from the generated Swagger document. You will need to include the NSwag.AspNetCore package from NuGet.

answered Nov 23 '20 at 06:11

BusyBee

219
3
6

1

Is there concern in using Swashbuckle + NSwag in the same project? Is there overlap in functionality? – fix Mar 15 '22 at 18:30

Ignore Property From Swagger UI

5 Answers5