Camelcase Json Result Wth Json Net

.NET has PascalCase naming convention for properties while Javascript has camelCase. Is there an easy way to convert the Json result? The answer is Json.NET. This article will show you how to create a custom result with Json.NET.

Install Newtonsoft.Json Nuget Package
Custom Action Result

public class JsonCamelCaseResult : ActionResult
{
    public Encoding ContentEncoding { get; set; }

    public string ContentType { get; set; }

    public object Data { get; set; }

    public override void ExecuteResult(ControllerContext context)
    {
        if (context == null)
        {
            throw new ArgumentNullException(nameof(context));
        }

        HttpResponseBase response = context.HttpContext.Response;
        response.ContentType = !string.IsNullOrEmpty(ContentType) ? ContentType : "application/json";
        if (ContentEncoding != null)
        {
            response.ContentEncoding = ContentEncoding;
        }
        if (Data != null)
        {
            var jsonSerializerSettings = new JsonSerializerSettings
            {
                ContractResolver = new CamelCasePropertyNamesContractResolver()
            };

            response.Write(JsonConvert.SerializeObject(Data, jsonSerializerSettings));
        }
    }
}

We use CamelCasePropertyNamesContractResolver to convert PascalCase into camelCase.

Controller Extension Method

public static class JsonCamelCaseHelper
{
    public static JsonCamelCaseResult JsonCamelCase(this Controller controller, object data)
    {
        return new JsonCamelCaseResult
        {
            Data = data
        };
    }
}

This extension method can save us some typing. We can use this.JsonCamelCase([data]) in any controllers. Or you can put this method into your base controller if you have one.

Usage

public ActionResult Index()
{
    var product = new Product
    {
        FancyName = "iPad Pro",
        SalesPrice = 12.10m
    };
    return this.JsonCamelCase(product);
}

‘FancyName’ will be changed to ‘fancyName’ in the result.

Gist

https://gist.github.com/dujushi/890bf6b4455a58a7256e

Gist

References