How to set custom JsonSerializerSettings for Json.NET in ASP.NET Web API?

Question

I understand that ASP.NET Web API natively uses Json.NET for (de)serializing objects, but is there a way to specify a JsonSerializerSettings object that you want for it to use?

For example, what if I wanted to include type information into the serialized JSON string? Normally I'd inject settings into the .Serialize() call, but Web API does that silently. I can't find a way to inject settings manually.

carlosfigueira · Accepted Answer · 2012-11-07 17:17:08Z

120

You can customize the JsonSerializerSettings by using the Formatters.JsonFormatter.SerializerSettings property in the HttpConfiguration object.

For example, you could do that in the Application_Start() method:

protected void Application_Start()
{
    HttpConfiguration config = GlobalConfiguration.Configuration;
    config.Formatters.JsonFormatter.SerializerSettings.Formatting =
        Newtonsoft.Json.Formatting.Indented;
}

answered Nov 7, 2012 at 17:17

carlosfigueira

87.7k14 gold badges137 silver badges176 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Piotr Kula Over a year ago

I cant get this to work in ASP.NET app with HangFire installed. It is referencing the incorrect libarary or something. had to use the other answer with Default settings..

Alx Over a year ago

You can do it per controller or action: stackoverflow.com/questions/44499041/…

smockle · Accepted Answer · 2013-09-16 16:33:54Z

48

You can specify JsonSerializerSettings for each JsonConvert, and you can set a global default.

Single JsonConvert with an overload:

// Option #1.
JsonSerializerSettings config = new JsonSerializerSettings { ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore };
this.json = JsonConvert.SerializeObject(YourObject, Formatting.Indented, config);

// Option #2 (inline).
JsonConvert.SerializeObject(YourObject, Formatting.Indented,
    new JsonSerializerSettings() {
        ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore
    }
);

Global Setting with code in Application_Start() in Global.asax.cs:

JsonConvert.DefaultSettings = () => new JsonSerializerSettings {
     Formatting = Newtonsoft.Json.Formatting.Indented,
     ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore
};

Reference: https://github.com/JamesNK/Newtonsoft.Json/issues/78

edited Sep 16, 2013 at 16:33

answered Sep 16, 2013 at 16:27

smockle

2,32219 silver badges19 bronze badges

3 Comments

lc. Over a year ago

FWIW, the second method was what I initially tried which did not work. I had to use HttpConfiguration instead as in carlosfigueira's answer as settings configured in JsonConvert.DefaultSettings were not being observed.

Piotr Kula Over a year ago

In my case the Global setting usgin JsonSerializerSettings is what worked for me. I could not get the HttpCOnfiguration to work, it was comming back with another assemblies methods (Hangifre) not sure why.

Kiquenet Over a year ago

Can I use hidden field formHiddenField.Value = JsonConvert.SerializeObject(listaCursos, Formatting.Indented, jsonSerializerSettings); and use JQuery for get the value var data = $('#formHiddenField').val(); ?

AEMLoviji · Accepted Answer · 2016-08-19 03:49:12Z

1

Answer is adding this 2 lines of code to Global.asax.cs Application_Start method

var json = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
json.SerializerSettings.PreserveReferencesHandling = 
    Newtonsoft.Json.PreserveReferencesHandling.All;

Reference: Handling Circular Object References

answered Aug 19, 2016 at 3:49

AEMLoviji

3,2779 gold badges41 silver badges61 bronze badges

Collectives™ on Stack Overflow

How to set custom JsonSerializerSettings for Json.NET in ASP.NET Web API?

3 Answers 3

2 Comments

3 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

2 Comments

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related