JSON.NET as a WebAPI 2 OData serializer vs ODataMediaTypeFormatter

by

I’ve already figured out my problem and found the solution. OData uses separate media type formatters, inherited from ODataMediaTypeFormatter. Also OData uses different formatters for serialization and deserialization. For replacing this behavior we have to implement descendants of ODataDeserializerProvider and/or ODataSerializerProvider classes and add those classes to the HttpConfiguration.Formatters collections by

var odataFormatters = ODataMediaTypeFormatters
    .Create(new MyODataSerializerProvider(), new MuODataDeserializerProvider());
config.Formatters.AddRange(odataFormatters);

Small deserialization provider example:

public class JsonODataDeserializerProvider : ODataDeserializerProvider
{
    public override ODataEdmTypeDeserializer GetEdmTypeDeserializer(IEdmTypeReference edmType)
    {
        var kind = GetODataPayloadKind(edmType);

        return new JsonODataEdmTypeDeserializer(kind, this);
    }

    private static ODataPayloadKind GetODataPayloadKind(IEdmTypeReference edmType)
    {
        switch (edmType.TypeKind())
        {
            case EdmTypeKind.Entity:
                return ODataPayloadKind.Entry;
            case EdmTypeKind.Primitive:
            case EdmTypeKind.Complex:
                return ODataPayloadKind.Property;
            case EdmTypeKind.Collection:
                IEdmCollectionTypeReference collectionType = edmType.AsCollection();
                return collectionType.ElementType().IsEntity() ? ODataPayloadKind.Feed : ODataPayloadKind.Collection;
            default:
                return ODataPayloadKind.Entry;
        }
    }

    public override ODataDeserializer GetODataDeserializer(IEdmModel model, Type type, HttpRequestMessage request)
    {
        var edmType = model.GetEdmTypeReference(type);

        return edmType == null ? null : GetEdmTypeDeserializer(edmType);
    }
}

ODataDeserializer:

public class JsonODataEdmTypeDeserializer : ODataEdmTypeDeserializer
{
    public JsonODataEdmTypeDeserializer(ODataPayloadKind payloadKind) : base(payloadKind)
    {
    }

    public JsonODataEdmTypeDeserializer(ODataPayloadKind payloadKind, ODataDeserializerProvider deserializerProvider) : base(payloadKind, deserializerProvider)
    {
    }

    public override object Read(ODataMessageReader messageReader, Type type, ODataDeserializerContext readContext)
    {
        var data = readContext.Request.Content.ReadAsStringAsync().Result;

        return JsonConvert.DeserializeObject(data, type);
    }
}

And I also have added EdmLibsHelper class from WebAPI OData source code in my project with GetEdmTypeReference() and GetEdmType() methods because this class is internal.

More Related Contents:

  1. Conditional member serialization based on query parameter?
  2. JSON.NET Parser *seems* to be double serializing my objects
  3. Self referencing loop detected – Getting back data from WebApi to the browser
  4. How to use Newtonsoft.Json as default in Asp.net Core Web Api?
  5. custom serializer for just one property in Json.NET
  6. .NET WebAPI Serialization k_BackingField Nastiness
  7. TypeNameHandling caution in Newtonsoft Json
  8. JSON.NET Error Self referencing loop detected for type
  9. Cannot deserialize the JSON array (e.g. [1,2,3]) into type ‘ ‘ because type requires JSON object (e.g. {“name”:”value”}) to deserialize correctly
  10. Detect if deserialized object is missing a field with the JsonConvert class in Json.NET
  11. Can Json.NET serialize / deserialize to / from a stream?
  12. Json.net serialize/deserialize derived types?
  13. Using Json.NET converters to deserialize properties
  14. How to ignore JsonProperty(PropertyName = “someName”) when serializing json?
  15. Exclude property from serialization via custom attribute (json.net)
  16. How to serialize/deserialize a custom collection with additional properties using Json.Net
  17. Serialize a container of enums as strings using JSON.net
  18. Force JSON.NET to include milliseconds when serializing DateTime (even if ms component is zero)
  19. Can Newtonsoft Json.NET skip serializing empty lists?
  20. How to deserialize a JObject to .NET object
  21. Serializing null in JSON.NET
  22. Serializing an interface/abstract object using NewtonSoft.JSON
  23. Json.NET: Deserializing nested dictionaries
  24. Dates without time in ASP.NET Web API’s JSON output
  25. JSonNet boolean serialization
  26. Serialize only interface properties to JSON with Json.net
  27. Ignore Base Class Properties in Json.NET Serialization
  28. What’s the best way to jSON serialize a .NET DataTable in WCF?
  29. Is there a way in Json.NET serialization to distinguish between “null because not present” and “null because null”?
  30. Json.net serialization of custom collection implementing IEnumerable

Leave a Comment