Use JsonProperty if it exists otherwise use camelcase

Question

I have the following class:

public sealed class CRMUser
{
    /// The display name.
    /// </value>
    [JsonProperty("name")]
    public string DisplayName { get; set; }

    [JsonProperty("email")]
    public string EmailAddress { get; set; }

    [JsonProperty("phone")]
    public string PhoneNumber { get; set; }
}

Which when I returned it as Json in a controller eg

return Json(crmUser);

it was returning the object with camel case and ignoring the JsonProperty attributes. To get around this, I had to add the following:

services.AddControllers()
    .AddNewtonsoftJson(options =>
    {
        // this allows us to use the JsonProperty attribute when returning Json in an action
        options.SerializerSettings.ContractResolver = new DefaultContractResolver(); // this resolver is from newtonsoft.json
    });

This works but now any class that I haven't used JsonProperty attribute on is no longer camel case - is there a way to get it to use the property if it exists and if not, fall back to camel casing?

Did you try passing in CamelCaseNamingStrategy to the contract resolver? — Kirk Woll
– Kirk Woll, Commented Jun 27, 2022 at 13:31
Perfect, that's done the trick - if you add that as an answer I can accept it. Thanks — Pete
– Pete, Commented Jun 27, 2022 at 13:34

Kirk Woll · Accepted Answer · 2022-06-27 14:48:14Z

3

To tell Json.Net to use camel casing by default, you have to provide that option when creating the DefaultContractResolver:

DefaultContractResolver contractResolver = new DefaultContractResolver
{
    NamingStrategy = new CamelCaseNamingStrategy()
};

The docs go into more details.

answered Jun 27, 2022 at 14:48

Kirk Woll

77.8k23 gold badges189 silver badges200 bronze badges

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

Collectives™ on Stack Overflow

Use JsonProperty if it exists otherwise use camelcase

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related