×
Dan Schiumarini

ASP.NET Core 3.1: Default System.Text.Json Settings Don't Roundtrip (Serialize/Deserialize) Through Test Server

Written by Ken Dale
2
This post is days old.

We’ve spotted some strange behavior before with ASP.NET Core and JSON serialization/deserialization, and I eventually made it back to trying out some scenarios.

One thing I’ve noticed is the default System.Text.Json settings don’t roundtrip (that is, serialize and deserialize) through the ASP.NET Core 3.1 TestServer (without additional configuration).

The underlying issue is by default there’s a character case mismatch.

Making It Work

One way to make it work is setting the property names case insensitive when deserializing the response:

var responseObj = JsonSerializer.Deserialize<TestObject>(strContent, new JsonSerializerOptions
{
    // Required for test to pass, by default
    // there's a case mismatch that isn't automatically handled
    PropertyNamingPolicy = JsonNamingPolicy.CamelCase
    // or
    // PropertyNameCaseInsensitive = true
});

Alternatively, we could update the character case to match expectations via an attribute ([JsonPropertyName("StringValue")]) on each property.

In Closing

A test associated with this post is at https://github.com/kendaleiv/AspNetCoreJsonTests/blob/9c57b5425c8bac5bbb4440f676110e0dfc6fb75d/UnitTest1.cs#L51-L93.

Ken Dale
Ken Dale
Senior Application Developer (Former)
asp.net core
Suggested reading

Defaulting ASP.NET Core 3.1 To Require Authentication For A Safer Developer Experience

asp.net core
Typically with ASP.NET Core 3.1 when no specific authorization requirements a...
Read now

Swagger Grouping With Controller Name Fallback Using Swashbuckle.AspNetCore

asp.net core
We’ve been using Swagger via Swashbuckle for some time with our ASP.NET Full ...
Read now

ASP.NET Core 3.1: Newtonsoft.Json Issues With Enumerable.Empty Assignment

asp.net core
We’ve spotted some strange behavior before with ASP.NET Core and JSON seriali...
Read now

Fixing ASP.NET Core's UseStatusCodePages Middleware

asp.net core
Here at RIMdev, we are unapologetic about our love for static websites. Folks...
Read now

Strongly Typed Feature Flags With ASP.NET Core 2.2

asp.net core
Feature flags can be useful for changing the runtime behavior of an applicati...
Read now

Multi Instance ASP.NET Core 2.2 Data Protection Using Redis and an Azure Key Vault Certificate

asp.net core
We’re in the process of upgrading our infrastructure to run our Azure Web App...
Read now

Comments

Stay fresh! The brighter green, the fresher the article!