How to ignore JsonProperty(PropertyName = “someName”) when serializing json?

by

This can be done pretty easily using a custom contract resolver. Here’s all the code you would need:

class LongNameContractResolver : DefaultContractResolver
{
    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
    {
        // Let the base class create all the JsonProperties 
        // using the short names
        IList<JsonProperty> list = base.CreateProperties(type, memberSerialization);

        // Now inspect each property and replace the 
        // short name with the real property name
        foreach (JsonProperty prop in list)
        {
            prop.PropertyName = prop.UnderlyingName;
        }

        return list;
    }
}

Here’s a quick demo using the resolver:

class Program
{
    static void Main(string[] args)
    {
        Foo foo = new Foo
        {
            CustomerName = "Bubba Gump Shrimp Company",
            CustomerNumber = "BG60938"
        };

        Console.WriteLine("--- Using JsonProperty names ---");
        Console.WriteLine(Serialize(foo, false));
        Console.WriteLine();
        Console.WriteLine("--- Ignoring JsonProperty names ---");
        Console.WriteLine(Serialize(foo, true));
    }

    static string Serialize(object obj, bool useLongNames)
    {
        JsonSerializerSettings settings = new JsonSerializerSettings();
        settings.Formatting = Formatting.Indented;
        if (useLongNames)
        {
            settings.ContractResolver = new LongNameContractResolver();
        }

        return JsonConvert.SerializeObject(obj, settings);
    }
}

class Foo
{
    [JsonProperty("cust-num")]
    public string CustomerNumber { get; set; }
    [JsonProperty("cust-name")]
    public string CustomerName { get; set; }
}

Output:

--- Using JsonProperty names ---
{
  "cust-num": "BG60938",
  "cust-name": "Bubba Gump Shrimp Company"
}

--- Ignoring JsonProperty names ---
{
  "CustomerNumber": "BG60938",
  "CustomerName": "Bubba Gump Shrimp Company"
}

More Related Contents:

  1. Does Json.NET cache types’ serialization information?
  2. Cannot deserialize the JSON array (e.g. [1,2,3]) into type ‘ ‘ because type requires JSON object (e.g. {“name”:”value”}) to deserialize correctly
  3. How to deserialize an array of values with a fixed schema to a strongly typed data class?
  4. Detect if deserialized object is missing a field with the JsonConvert class in Json.NET
  5. Using JsonConvert.DeserializeObject to deserialize Json to a C# POCO class
  6. JSON.Net throws StackOverflowException when using [JsonConvert()]
  7. Json.Net: Serialize/Deserialize property as a value, not as an object
  8. “Self Referencing Loop Detected” exception with JSON.Net
  9. Newtonsoft.JSON cannot convert model with TypeConverter attribute
  10. How to serialize/deserialize a custom collection with additional properties using Json.Net
  11. Deserialize json array stream one item at a time
  12. How to deserialize a JSON property that can be two different data types using Json.NET
  13. Custom Deserialization using Json.NET
  14. Serialize Property, but Do Not Deserialize Property in Json.Net
  15. Force JSON.NET to include milliseconds when serializing DateTime (even if ms component is zero)
  16. How to make JSON.Net serializer to call ToString() when serializing a particular type?
  17. Json.NET custom serialization with JsonConverter – how to get the “default” behavior
  18. Cannot deserialize the current JSON array (e.g. [1,2,3])
  19. Cannot deserialize JSON array into type – Json.NET
  20. How to apply indenting serialization only to some properties?
  21. Ignoring null fields in Json.net
  22. Repeated serialization and deserialization creates duplicate items
  23. How to apply ObjectCreationHandling.Replace to selected properties when deserializing JSON?
  24. Convert DataTable to JSON with key per row
  25. Deserialize specific enum into system.enum in Json.Net
  26. Json.net deserialization null guid case
  27. Deserializing JSON into an object with Json.NET
  28. Ignore Base Class Properties in Json.NET Serialization
  29. NewtonSoft.Json Serialize and Deserialize class with property of type IEnumerable
  30. Json.net serialization of custom collection implementing IEnumerable

Leave a Comment