Ensuring json keys are lowercase in .NET

Question

Is there simple way using JSON in .NET to ensure that the keys are sent as lower case?

At the moment I'm using the newtonsoft's Json.NET library and simply using

string loginRequest = JsonConvert.SerializeObject(auth);

In this case auth is just the following object

public class Authority
{
    public string Username { get; set; }
    public string ApiToken { get; set; }
}

This results in

{"Username":"Mark","ApiToken":"xyzABC1234"}

Is there a way to ensure that the username and apitoken keys come through as lowercase?

I don't want to simply run it through String.ToLower() of course because the values for username and apitoken are mixed case.

I realise I can programatically do this and create the JSON string manually, but I need this for approx 20 or so JSON data strings and I'm seeing if I can save myself some time. I'm wondering if there are any already built libraries that allow you to enforce lowercase for key creation.

Maybe the json serialization lib offers some kind of serialization attributes you could use to change the json-serialized names of your properties? — tdammers
– tdammers, Commented Jun 9, 2011 at 6:02
@tdammers, thanks I'm trying to find something that does that, but so far unsuccessful. Hoping someone here could point me to it. — Mark
– Mark, Commented Jun 9, 2011 at 6:09
This can be useful in case you propety consists of one word. — Lipotam
– Lipotam, Commented Jul 17, 2012 at 14:17
Huh. I'm having the opposite problem... also -- it's funny that you mention "Username" is mixed case. Did you mean "UserName"? — BrainSlugs83
– BrainSlugs83, Commented Oct 23, 2015 at 7:56
No simply that the values needed to remain mixed case the keys Only were what I need to touch. Value leave alone. — Mark
– Mark, Commented Oct 23, 2015 at 21:46

rgripper · Accepted Answer · 2013-01-12 13:30:52Z

191

You can create a custom contract resolver for this. The following contract resolver will convert all keys to lowercase:

public class LowercaseContractResolver : DefaultContractResolver
{
    protected override string ResolvePropertyName(string propertyName)
    {
        return propertyName.ToLower();
    }
}

Usage:

var settings = new JsonSerializerSettings();
settings.ContractResolver = new LowercaseContractResolver();
var json = JsonConvert.SerializeObject(authority, Formatting.Indented, settings);

Wil result in:

{"username":"Mark","apitoken":"xyzABC1234"}

If you always want to serialize using the LowercaseContractResolver, consider wrapping it in a class to avoid repeating yourself:

public class LowercaseJsonSerializer
{
    private static readonly JsonSerializerSettings Settings = new JsonSerializerSettings
    {
        ContractResolver = new LowercaseContractResolver()
    };

    public static string SerializeObject(object o)
    {
        return JsonConvert.SerializeObject(o, Formatting.Indented, Settings);
    }

    public class LowercaseContractResolver : DefaultContractResolver
    {
        protected override string ResolvePropertyName(string propertyName)
        {
            return propertyName.ToLower();
        }
    }
}

Which can be used like this:

var json = LowercaseJsonSerializer.SerializeObject(new { Foo = "bar" });
// { "foo": "bar" }

ASP.NET MVC4 / WebAPI

If you are using ASP.NET MVC4 / WebAPI, you can use a CamelCasePropertyNamesContractResolver from Newtonsoft.Json library which included by default.

edited Jan 12, 2013 at 13:30

rgripper

1,0961 gold badge15 silver badges23 bronze badges

answered Jun 9, 2011 at 6:08

alexn

59.2k14 gold badges113 silver badges146 bronze badges

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

8 Comments

Shaun Rowan Over a year ago

any reasonable way to do this in reverse? For deserialization?

alexn Over a year ago

@Anzeo I have not tried to do that myself, and I did not find any information about that in the documentation. A solution would be to wrap JsonConvert.SerializeObject in your own class. See my update.

rekna Over a year ago

It seems, this custom contractresolver does not take into account the JsonProperty attribute, if you want to specify exceptions... e.g. [JsonProperty("alternateName")] still gets lowercased or is there another way to do it ?

CallMeLaNN Over a year ago

+1 for pointing out the CamelCasePropertyNamesContractResolver. Now I found System.Net.Http.Formatting.JsonContractResolver is the default in WebAPI and this class is internal. I endup with rewrite JsonContractResolver with camel case. Someone reported this to be public aspnetwebstack.codeplex.com/workitem/228

ToXinE Over a year ago

CamelCasePropertyNamesContratResolver do not transform the properties in lowercase, just the first char.

|

Sagi · Accepted Answer · 2015-12-10 01:04:38Z

25

protected void Application_Start() {
    JsonConfig.Configure();   
}

public static class JsonConfig
{
    public static void Configure(){
        var formatters = GlobalConfiguration.Configuration.Formatters;
        var jsonFormatter = formatters.JsonFormatter;
        var settings = jsonFormatter.SerializerSettings;

        settings.ContractResolver = new CamelCasePropertyNamesContractResolver();
    }
}

answered Dec 10, 2015 at 1:04

Sagi

9,3643 gold badges38 silver badges43 bronze badges

Comments

dbc · Accepted Answer · 2017-12-15 20:36:50Z

In Json.NET 9.0.1 and later it is possible to ensure that all property names are converted to lowercase by using a custom NamingStrategy. This class extracts the logic for algorithmic remapping of property names from the contract resolver to a separate, lightweight object that can be set on DefaultContractResolver.NamingStrategy. Doing so avoids the need to create a custom ContractResolver and thus may be easier to integrate into frameworks that already have their own contract resolvers.

Define LowercaseNamingStrategy as follows:

public class LowercaseNamingStrategy : NamingStrategy
{
    protected override string ResolvePropertyName(string name)
    {
        return name.ToLowerInvariant();
    }
}

Then serialize as follows:

var settings = new JsonSerializerSettings
{
    ContractResolver = new DefaultContractResolver { NamingStrategy = new LowercaseNamingStrategy() },
};
string loginRequest = JsonConvert.SerializeObject(auth, settings);

Notes -

Using string.ToLowerInvariant() ensures that the same contract is generated in all locales.
To control whether overridden property names, dictionary keys and extension data names are lowercased, you can set NamingStrategy.OverrideSpecifiedNames, NamingStrategy.ProcessDictionaryKeys or NamingStrategy.ProcessExtensionDataNames (Json.NET 10.0.1 and later) to true.
You may want to cache the contract resolver for best performance.

If you do not have access to the serializer settings in your framework, you can apply a NamingStrategy directly to your object as follows:

[JsonObject(NamingStrategyType = typeof(LowercaseNamingStrategy))]
public class Authority
{
    public string Username { get; set; }
    public string ApiToken { get; set; }
}

Do not modify the NamingStrategy of CamelCasePropertyNamesContractResolver. This contract resolver shares type information globally across all of its instances, and so modifying any one instance can have unexpected side effects.

Great answer with all the information I needed to get the serializer to do what I wanted. Especially for what not to do. Very useful. Thank you much!

Jorgelig · Accepted Answer · 2017-11-24 00:18:25Z

12

you can use "JsonProperty":

Usage:

public class Authority
{
    [JsonProperty("userName")] // or [JsonProperty("username")]
    public string Username { get; set; }
    [JsonProperty("apiToken")] // or [JsonProperty("apitoken")]
    public string ApiToken { get; set; }
}

var json  = JsonConvert.SerializeObject(authority);

answered Nov 24, 2017 at 0:18

Jorgelig

3043 silver badges10 bronze badges

Comments

Stiven Fortes · Accepted Answer · 2023-07-06 14:09:25Z

1

As per Microsoft Documentation a simpler way could be used:

    var options = new JsonSerializerOptions
    {
        PropertyNameCaseInsensitive = true,
        PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
    };

    var json = JsonSerializer.Deserialize<Authority>(auth, options);

answered Jul 6, 2023 at 14:09

Stiven Fortes

914 bronze badges

Comments

Uwe Keim · Accepted Answer · 2023-08-08 13:14:43Z

0

For me I used a combination of some of the other answers and ended up with this

return JsonConvert.SerializeObject(obj, Formatting.Indented, new JsonSerializerSettings
{
    ContractResolver = new CamelCasePropertyNamesContractResolver()
});

was closer to a solution to what I was looking for as I was not looking to create my own.

edited Aug 8, 2023 at 13:14

Uwe Keim

40.9k61 gold badges193 silver badges308 bronze badges

answered Feb 11, 2020 at 0:30

workabyte

3,8152 gold badges33 silver badges37 bronze badges

Collectives™ on Stack Overflow

Ensuring json keys are lowercase in .NET

6 Answers 6

ASP.NET MVC4 / WebAPI

8 Comments

Comments

1 Comment

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

ASP.NET MVC4 / WebAPI

8 Comments

Comments

1 Comment

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related