Setting IgnoreSerializableAttribute Globally in Json.net

Question

I'm working on a ASP.NET WebApi (Release Candidate) project where I'm consuming several DTOs that are marked with the [Serializable] attribute. These DTOs are outside of my control so I'm not able to modify them in any way. When I return any of these from a get method the resulting JSON contains a bunch of k__BackingFields like this:

<Name>k__BackingField=Bobby
<DateCreated>k__BackingField=2012-06-19T12:35:18.6762652-05:00

Based on the searching I've done this seems like a problem with JSON.NET's IgnoreSerializableAttribute setting and to resolve my issue I just need to set it globally as the article suggests. How do I change this setting globally in a ASP.NET Web api project?

score 37 · Accepted Answer · answered Jul 10 '12 at 20:33

37

I found easy way to get rid of k__BackingField in the names.

This fragment should be somewhere in the Application_Start() in Global.asax.cs:

JsonSerializerSettings jSettings = new Newtonsoft.Json.JsonSerializerSettings();
GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings = jSettings;

Looks like the default setting takes care of it.

answered Jul 10 '12 at 20:33

VikVik

1,045
2
11
15

1

Very helpful tip for anyone using MVC4/WebApi! – EkoostikMartin Dec 12 '12 at 20:10
It work for me even. Can we make this default setting in IIS ? – pixelbyaj Oct 20 '15 at 06:42

Marcel N. · Answer 2 · 2012-06-20T18:28:23.880

Since the library does not expose a static setter for the DefaultContractResolver, I suggest you create a static wrapper over JsonConvert and it's Serialize*/Deserialize* methods (at least the ones you use).

In your static wrapper you can define a static contract resolver:

private static readonly DefaultContractResolver Resolver = new DefaultContractResolver
{
    IgnoreSerializableAttribute = true
};

This you can pass to each serialization method in the JsonSerializerSettings, inside your wrapper. Then you call your class throughout your project.

The alternative would be to get the JSON.NET source code and adjust it yourself to use that attribute by default.

score 0 · Answer 3 · answered Sep 13 '18 at 14:22

For me, the following fixed the issue with circular references and k__BackingField.

In your WebApiConfig add the following to the Register() method:

JsonSerializerSettings jSettings = new Newtonsoft.Json.JsonSerializerSettings {

    ContractResolver = new DefaultContractResolver {
        IgnoreSerializableAttribute = true
    },
    ReferenceLoopHandling = ReferenceLoopHandling.Ignore
};

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings = jSettings;

score -2 · Answer 4 · answered Feb 11 '16 at 12:42

-2

Friends, don't declare properties like this:

public String DiscretionCode { get; set; }

But, create auxiliar vars, like old....

private String discretionCode;

public String DiscretionCode 
{ 
    get { return discretionCode;}
    set { discretionCode = value; }
}

answered Feb 11 '16 at 12:42

Humberto Gonçalves de Almeida

17
1

Please explain your reasoning – Shahzad Qureshi Feb 22 '17 at 22:01
In the first form, the compiler creates the variable (backing field) for you automatically. The second form has not advantages over the first one, it takes more time to write and it is harder to read. – Daniel Santos Aug 10 '20 at 12:39

Setting IgnoreSerializableAttribute Globally in Json.net

4 Answers4

Linked