Use different name for serializing and deserializing with Json.Net

by

You can make use of the JsonSerializerSettings, the ContractResolver and the NamingStrategy.

public class ErrorDetails
{
    public int Id { get; set; }
    public string ErrorMessage { get; set; }
}

var json = "{'Id': 1,'error_message': 'An error has occurred!'}";

For dezerialization you could use the SnakeCaseNamingStrategy.

var dezerializerSettings = new JsonSerializerSettings
{
    ContractResolver = new DefaultContractResolver
    {
        NamingStrategy = new SnakeCaseNamingStrategy()
    }
};
var obj = JsonConvert.DeserializeObject<ErrorDetails>(json, dezerializerSettings);

To serialize the object again you dont have to change the JsonSerializerSettings as the default will use the property name.

var jsonNew = JsonConvert.SerializeObject(obj);

jsonNew = “{‘Id’: 1,’ErrorMessage’: ‘An error has occurred!’}”

Or you could create a contract resolver which can decide which name to use. Then you can decide when you dezerialize and serialize if you want to use the pascal case name format or the one with the underscore.

public class CustomContractResolver : DefaultContractResolver
{
    public bool UseJsonPropertyName { get; }

    public CustomContractResolver(bool useJsonPropertyName)
    {
        UseJsonPropertyName = useJsonPropertyName;
    }

    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
    {
        var property = base.CreateProperty(member, memberSerialization);
        if (!UseJsonPropertyName)
            property.PropertyName = property.UnderlyingName;

        return property;
    }
}

public class ErrorDetails
{
    public int Id { get; set; }
    [JsonProperty("error_message")]
    public string ErrorMessage { get; set; }
}


var json = "{'Id': 1,'error_message': 'An error has occurred!'}";
var serializerSettings = new JsonSerializerSettings()
{
    ContractResolver = new CustomContractResolver(false)
};
var dezerializerSettings = new JsonSerializerSettings
{
    ContractResolver = new CustomContractResolver(true)
};

var obj = JsonConvert.DeserializeObject<ErrorDetails>(json, dezerializerSettings);
var jsonNew = JsonConvert.SerializeObject(obj, serializerSettings);

jsonNew = “{‘Id’: 1,’ErrorMessage’: ‘An error has occurred!’}”

More Related Contents:

  1. Deserialize JSON into C# dynamic object?
  2. JSON.NET Error Self referencing loop detected for type
  3. Does Json.NET cache types’ serialization information?
  4. Cannot deserialize the JSON array (e.g. [1,2,3]) into type ‘ ‘ because type requires JSON object (e.g. {“name”:”value”}) to deserialize correctly
  5. Getting ServiceStack to retain type information
  6. Detect if deserialized object is missing a field with the JsonConvert class in Json.NET
  7. Json.net serialize/deserialize derived types?
  8. Using JsonConvert.DeserializeObject to deserialize Json to a C# POCO class
  9. How to ignore JsonProperty(PropertyName = “someName”) when serializing json?
  10. Json.Net: Serialize/Deserialize property as a value, not as an object
  11. How to serialize/deserialize a custom collection with additional properties using Json.Net
  12. Deserializing JSON to abstract class
  13. Not ableTo Serialize Dictionary with Complex key using Json.net
  14. How to deserialize a JSON property that can be two different data types using Json.NET
  15. Custom Deserialization using Json.NET
  16. How can I serialize and deserialize a type with a string member that contains “raw” JSON, without escaping the JSON in the process
  17. Force JSON.NET to include milliseconds when serializing DateTime (even if ms component is zero)
  18. How to use default serialization in a custom System.Text.Json JsonConverter?
  19. C# automatic property deserialization of JSON
  20. Cannot deserialize the current JSON array (e.g. [1,2,3])
  21. Ignoring a field during .NET JSON serialization; similar to [XmlIgnore]?
  22. Repeated serialization and deserialization creates duplicate items
  23. Convert DataTable to JSON with key per row
  24. Deserialize specific enum into system.enum in Json.Net
  25. Serializing an interface/abstract object using NewtonSoft.JSON
  26. object to deserialize has a C# keyword
  27. Json.NET: Deserializing nested dictionaries
  28. Change default date serialization in WCF
  29. JSonNet boolean serialization
  30. Configure Json.NET serialization settings on a class level

Leave a Comment