How to tell Json.Net globally to apply the StringEnumConverter to all enums

Question

I want to deserialize enumerations to their string representation and vice versa with json.net. The only way I could figure out to tell the framework to apply its StringEnumConverter is to annotate the properties in question like this:

[JsonConverter(typeof(StringEnumConverter))] public virtual MyEnums MyEnum { get; set; }

However, in my use case, it would be much more convenient to configure json.net globally such that all enumerations get (de)serialized using the StringEnumConverter, without the need of extra annotations.

Is there any way to do so, e.g. with the help of custom JsonSerializerSettings?

BanksySan · Accepted Answer · 2017-01-27 14:57:17Z

118

Add a StringEnumConverter to the JsonSerializerSettings Converters collection.

Documentation: Serialize with JsonConverters

If you want the serializer to use camelCasing, you can set this as well:

SerializerSettings.Converters.Add( new StringEnumConverter { CamelCaseText = true });

This will serialize SomeValue to someValue.

edited Jan 27, 2017 at 14:57

BanksySan

28.7k36 gold badges128 silver badges231 bronze badges

answered Sep 15, 2011 at 22:29

James Newton-King

49.2k25 gold badges113 silver badges132 bronze badges

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

7 Comments

amhed Over a year ago

I tried setting this on my global.asax.cs under GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettingsbut didn't work. Any idea why that could be?

mikebridge Over a year ago

Is there any way to lower-case the field name? The CamelCaseText flag is hard-coded into the class and I don't see a way to use a different casing strategy.

Timm Over a year ago

@mikebridge Have you found a solution to this? Also looking for a way to set the name for each enum option myself (or use lowercase).

mikebridge Over a year ago

@Timm Yes, I used this post: stackoverflow.com/questions/6288660/…

Timm Over a year ago

@mikebridge Thanks. I found that [EnumMember (Value = "undefined")] per enum entry works fine with JSON.Net as well (though unsupported by Microsoft's JSON deserializer)

|

Gaz · Accepted Answer · 2015-10-23 08:58:45Z

42

The other answers work for ASP.NET, but if you want to set these settings generally for calling JsonConvert in any context you can do:

JsonConvert.DefaultSettings = (() => { var settings = new JsonSerializerSettings(); settings.Converters.Add(new StringEnumConverter {CamelCaseText = true}); return settings; });

(See http://james.newtonking.com/archive/2013/05/08/json-net-5-0-release-5-defaultsettings-and-extension-data)

edited Oct 23, 2015 at 8:58

answered Oct 1, 2013 at 16:44

Gaz

4,1443 gold badges34 silver badges34 bronze badges

3 Comments

Kapé Over a year ago

What I was looking for! Even shorter:

JsonConvert.DefaultSettings = () => new JsonSerializerSettings { Converters = { new StringEnumConverter { CamelCaseText = true } } };

crthompson Over a year ago

You saved me! Thanks bro! gist.github.com/regisdiogo/27f62ef83a804668eb0d9d0f63989e3e

Daniel Over a year ago

This is basically what you do in .NET 8 now, except it wants you to use strategy instead. E.g. settings.Converters.Add(new StringEnumConverter { NamingStrategy = new CamelCaseNamingStrategy() });

Iggy · Accepted Answer · 2013-08-09 17:59:51Z

In your Global.asax.cs add

HttpConfiguration config = GlobalConfiguration.Configuration; config.Formatters.JsonFormatter.SerializerSettings.Converters.Add (new Newtonsoft.Json.Converters.StringEnumConverter());

This solution seems to work perfectly for WebAPI serialization. Thanks!

Stephen · Accepted Answer · 2019-03-05 21:53:23Z

The previous answers are out of date as of Version 12.0.1. The new way is to use NamingStrategy. https://www.newtonsoft.com/json/help/html/NamingStrategyCamelCase.htm

serializerSettings.Converters.Add( new StringEnumConverter { NamingStrategy = new CamelCaseNamingStrategy() } );

Simon_Weaver · Accepted Answer · 2018-01-10 10:44:34Z

For ASP.NET Core 2 do the following:

 public void ConfigureServices(IServiceCollection services) { services.AddMvc() .AddJsonOptions(options => { options.SerializerSettings.Converters.Add(new StringEnumConverter()); }); ...

Please note this is not services.AddJsonOptions(...), it must be tagged onto MVC because you're creating settings for MVC.

reza.Nikmaram · Accepted Answer · 2023-04-24 07:45:03Z

Install the Swashbuckle.AspNetCore.Newtonsoft package.

services.AddControllers().AddNewtonsoftJson(o => { o.SerializerSettings.Converters.Add(new StringEnumConverter { //CamelCaseText = true,//absolete NamingStrategy = new CamelCaseNamingStrategy() }); }); services.AddSwaggerGenNewtonsoftSupport();

Collectives™ on Stack Overflow

How to tell Json.Net globally to apply the StringEnumConverter to all enums

6 Answers 6

7 Comments

3 Comments

1 Comment

Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

7 Comments

3 Comments

1 Comment

Comments

Comments

Comments

Linked

Related