Web API: Configure JSON serializer settings on action or controller level

by

Option 1 (quickest)

At action level you may always use a custom JsonSerializerSettings instance while using Json method:

public class MyController : ApiController
{
    public IHttpActionResult Get()
    {
        var settings = new JsonSerializerSettings
        {
            ContractResolver = new CamelCasePropertyNamesContractResolver()
        };
        var model = new MyModel();
        return Json(model, settings);
    }
}

Option 2 (controller level)

You may create a new IControllerConfiguration attribute which customizes the JsonFormatter:

public class CustomJsonAttribute : Attribute, IControllerConfiguration 
{
    public void Initialize(HttpControllerSettings controllerSettings, HttpControllerDescriptor controllerDescriptor)
    {
        var formatter = controllerSettings.Formatters.JsonFormatter;

        controllerSettings.Formatters.Remove(formatter);

        formatter = new JsonMediaTypeFormatter
        {
            SerializerSettings =
            {
                ContractResolver = new CamelCasePropertyNamesContractResolver()
            }
        };

        controllerSettings.Formatters.Insert(0, formatter);
    }
}

[CustomJson]
public class MyController : ApiController
{
    public IHttpActionResult Get()
    {
        var model = new MyModel();
        return Ok(model);
    }
}

More Related Contents:

  1. How to set custom JsonSerializerSettings for Json.NET in ASP.NET Web API?
  2. Specifying a custom DateTime format when serializing with Json.Net
  3. How to write a JSON file in C#?
  4. JSON.NET Parser *seems* to be double serializing my objects
  5. Web API 2: how to return JSON with camelCased property names, on objects and their sub-objects
  6. What is the difference between PreserveReferencesHandling and ReferenceLoopHandling in Json.Net?
  7. Set default global json serializer settings
  8. Serialize a container of enums as strings using JSON.net
  9. Self referencing loop detected – Getting back data from WebApi to the browser
  10. Selectively use default JSON converter
  11. JSON serialize properties on class inheriting list [duplicate]
  12. JSON Deserialization – String Is Automatically Converted To Int
  13. Is there a way in Json.NET serialization to distinguish between “null because not present” and “null because null”?
  14. Best practice to call ConfigureAwait for all server-side code
  15. Casting interfaces for deserialization in JSON.NET
  16. Deserialize collection of interface-instances?
  17. Web API Put Request generates an Http 405 Method Not Allowed error
  18. How can I encrypt selected properties when serializing my objects?
  19. How to update a claim in ASP.NET Identity?
  20. Converting newtonsoft code to System.Text.Json in .net core 3. what’s equivalent of JObject.Parse and JsonProperty
  21. HTTP 404 Page Not Found in Web Api hosted in IIS 7.5
  22. catch all unhandled exceptions in ASP.NET Web Api
  23. Keep casing when serializing dictionaries
  24. Send JSON via POST in C# and Receive the JSON returned?
  25. Deserializing heterogenous JSON array into covariant List using Json.NET
  26. How to return a file using Web API?
  27. Generate JSON object with NewtonSoft in a single line
  28. How to use caching in ASP.NET Web API?
  29. parsing an enumeration in JSON.net
  30. Json.Net deserialize out of memory issue

Leave a Comment