How to tell NewtonSoft.Json.JsonConvert to serialize an enum to a string and not an int

Question

I currently have a class say (that looks like this)

public class foo
{
    public MyEnumType Result { get; set; };
}

currently when I do this

foo a = new foo();
string str = JsonConvert.SerializeObject(a);

The Result comes out as int type. Is there a way for me to get it as string type ? by telling it to do MyEnumTypeInstance.toString();

DavidG · Accepted Answer · 2019-09-22 01:51:21Z

7

JSON.Net has a built-in converter, the StringEnumConverter, you just add an attribute to the property you are [de]serialising, for example:

[JsonConverter(typeof(StringEnumConverter))]
public MyEnumType Result { get; set; }

Or specify the converter during serialisation:

string str = JsonConvert.SerializeObject(a, new StringEnumConverter());

answered Sep 22, 2019 at 1:51

DavidG

120k13 gold badges232 silver badges239 bronze badges

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

3 Comments

DavidG Dec 18, 2024 at 14:23

@ChristopherHamkins Json.NET is Newtonsoft. The library is Json.NET and the name of the owner is Newtonsoft, after James Newton-King.

Christopher Hamkins Dec 19, 2024 at 15:51

OK thanks for the tip, I thought Json.NET is a different package.

MikeF Jul 29 at 18:47

This comment is not true (But was at one time I think) Json.Net nuget.org/packages/Json.Net Newtonsoft.Json nuget.org/packages/newtonsoft.json They have a couple subtle differences that can cause issues if you are not paying attention to wich one you are using.

Collectives™ on Stack Overflow

How to tell NewtonSoft.Json.JsonConvert to serialize an enum to a string and not an int

1 Answer 1

3 Comments

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Related