How can I return camelCase JSON serialized by JSON NET from ASP NET MVC controller methods

Question

My problem is that I wish to return camelCased  as opposed to the standard PascalCase  JSON data via ActionResults from ASP NET MVC controller methods  serialized by JSON NET   As an example consider the following C  class   public class Person       public string FirstName   get  set        public string LastName   get  set        By default  when returning an instance of this class from an MVC controller as JSON  it ll be serialized in the following fashion        FirstName    Joe      LastName    Public      I would like it to be serialized  by JSON NET  as        firstName    Joe      lastName    Public      How do I do this

User · Answer

I think this is the simple answer you are looking for  It s from Shawn Wildermuth s blog      Add MVC services to the services container  services AddMvc      AddJsonOptions opts   gt          opts SerializerSettings ContractResolver   new CamelCasePropertyNamesContractResolver

User · Answer

You must set the settings in the file  Startup cs   You also have to define it in the default values of JsonConvert  this is if you later want to directly use the library to serialize an object       public void ConfigureServices IServiceCollection services                services AddMvc   SetCompatibilityVersion CompatibilityVersion Version 2 2               AddJsonOptions options   gt                    options SerializerSettings NullValueHandling   NullValueHandling Ignore                  options SerializerSettings ContractResolver   new CamelCasePropertyNamesContractResolver                            JsonConvert DefaultSettings        gt  new JsonSerializerSettings                       NullValueHandling   NullValueHandling Ignore              ContractResolver   new CamelCasePropertyNamesContractResolver

User · Answer

Below is an action method that returns a json string  cameCase  by serializing an array of objects   public string GetSerializedCourseVms                 var courses   new                         new CourseVm Number    CREA101   Name    Care of Magical Creatures   Instructor   Rubeus Hagrid                new CourseVm Number    DARK502   Name    Defence against dark arts   Instructor   Severus Snape                new CourseVm Number    TRAN201   Name    Transfiguration   Instructor   Minerva McGonal                      var camelCaseFormatter   new JsonSerializerSettings            camelCaseFormatter ContractResolver   new CamelCasePropertyNamesContractResolver            return JsonConvert SerializeObject courses  camelCaseFormatter           Note the JsonSerializerSettings instance passed as the second parameter  That s what makes the camelCase happen

User · Answer

I found an excellent solution to this problem on Mats Karlsson s blog  The solution is to write a subclass of ActionResult that serializes data via JSON NET  configuring the latter to follow the camelCase convention   public class JsonCamelCaseResult   ActionResult       public JsonCamelCaseResult object data  JsonRequestBehavior jsonRequestBehavior                Data   data          JsonRequestBehavior   jsonRequestBehavior             public Encoding ContentEncoding   get  set         public string ContentType   get  set         public object Data   get  set         public JsonRequestBehavior JsonRequestBehavior   get  set         public override void ExecuteResult ControllerContext context                if  context    null                        throw new ArgumentNullException  context                      if  JsonRequestBehavior    JsonRequestBehavior DenyGet  amp  amp  String Equals context HttpContext Request HttpMethod   GET   StringComparison OrdinalIgnoreCase                         throw new InvalidOperationException  This request has been blocked because sensitive information could be disclosed to third party web sites when this is used in a GET request  To allow GET requests  set JsonRequestBehavior to AllowGet                        var response   context HttpContext Response           response ContentType    String IsNullOrEmpty ContentType    ContentType    application json           if  ContentEncoding    null                        response ContentEncoding   ContentEncoding                    if  Data    null              return           var jsonSerializerSettings   new JsonSerializerSettings                       ContractResolver   new CamelCasePropertyNamesContractResolver                      response Write JsonConvert SerializeObject Data  jsonSerializerSettings              Then use this class as follows in your MVC controller method   public ActionResult GetPerson         return new JsonCamelCaseResult new Person   FirstName    Joe   LastName    Public     JsonRequestBehavior AllowGet

User · Answer

Add Json NamingStrategy property to your class definition   x000D   x000D   JsonObject NamingStrategyType   typeof CamelCaseNamingStrategy    public class Person       public string FirstName   get  set        public string LastName   get  set      x000D   x000D   x000D

User · Answer

If you are returning ActionResult in  net core web api  or IHttpAction result then you can just wrap up your model in an Ok   method which will match the case on your front end and serialise it for you  No need to use JsonConvert

User · Answer

An alternative to the custom filter is to create an extension method to serialize any object to JSON   public static class ObjectExtensions            lt summary gt Serializes the object to a JSON string  lt  summary gt           lt returns gt A JSON string representation of the object  lt  returns gt      public static string ToJson this object value                var settings   new JsonSerializerSettings                       ContractResolver   new CamelCasePropertyNamesContractResolver                Converters   new List lt JsonConverter gt    new StringEnumConverter                         return JsonConvert SerializeObject value  settings             Then call it when returning from the controller action   return Content person ToJson     application json

User · Answer

Simpler is better IMO   Why don t you do this   public class CourseController   JsonController       public ActionResult ManageCoursesModel                 return JsonContent  lt somedata gt              The simple base class controller  public class JsonController   BaseController       protected ContentResult JsonContent Object data                return new ContentResult                       ContentType    application json                Content   JsonConvert SerializeObject data  new JsonSerializerSettings                  ContractResolver   new CamelCasePropertyNamesContractResolver                   ContentEncoding   Encoding UTF8

User · Answer

or  simply put   JsonConvert SerializeObject       lt YOUR OBJECT gt        new JsonSerializerSettings                 ContractResolver   new CamelCasePropertyNamesContractResolver              For instance   return new ContentResult       ContentType    application json       Content   JsonConvert SerializeObject new   content   result  rows   dto    new JsonSerializerSettings   ContractResolver   new CamelCasePropertyNamesContractResolver           ContentEncoding   Encoding UTF8

User · Answer

I did like this    public static class JsonExtension       public static string ToJson this object value                var settings   new JsonSerializerSettings                       ContractResolver   new CamelCasePropertyNamesContractResolver                NullValueHandling   NullValueHandling Ignore              ReferenceLoopHandling   ReferenceLoopHandling Serialize                    return JsonConvert SerializeObject value  settings             this a simple extension method in MVC core   it s going to give the ToJson   ability to every object in your project   In my opinion in a MVC project most of object should have the ability to become json  off course it depends

User · Answer

In ASP NET Core MVC       public IActionResult Foo                 var data   GetData             var settings   new JsonSerializerSettings                         ContractResolver   new CamelCasePropertyNamesContractResolver                         return Json data  settings

User · Answer

For WebAPI  check out this link   http   odetocode com blogs scott archive 2013 03 25 asp-net-webapi-tip-3-camelcasing-json aspx  Basically  add this code to your Application Start   var formatters   GlobalConfiguration Configuration Formatters  var jsonFormatter   formatters JsonFormatter  var settings   jsonFormatter SerializerSettings  settings ContractResolver   new CamelCasePropertyNamesContractResolver

[asp.net-mvc] How can I return camelCase JSON serialized by JSON.NET from ASP.NET MVC controller methods?

Examples related to asp.net-mvc

Examples related to json

Examples related to json.net

Examples related to camelcasing