fm.Extensions.Json 4.1.0

Description

Helpers for System.Text.Json. Most notably JsonExtensionObject as base class.

Examples

JsonExtensionObject

(De)Serializes properties into the base class without explicitly specifying them.

internal sealed class TestObject : JsonExtensionObject
{
    [JsonPropertyName("Id")]
    public int Id { get; set; }
}

TestObject testObject = JsonSerializer.Deserialize<TestObject>("""{ "Id": 1337, "Name": "TestName", "TestArray": [1, 3, 3, 7] }""")!;
testObject.Id.ShouldBe(1337);
testObject.ExtensionData.ItemsShould(
    kvp => kvp.Key.ShouldBe("Name"),
    kvp => kvp.Key.ShouldBe("TestArray"));

JsonSerializer.Serialize(testObject).ShouldBe("""{"Id":1337,"Name":"TestName","TestArray":[1,3,3,7]}""");

SpecificTypeJsonConverter

(De)Serializes classes or properties into a specific type

[JsonConverter(typeof(SpecificTypeJsonConverter<ITestObject, TestObject>))]
internal interface ITestObject
{
    int Id { get; set; }
}
internal sealed class TestObject : ITestObject
{
    [JsonPropertyName("Id")]
    public int Id { get; set; }
    [JsonPropertyName("AdditionalProp")]
    public string? AdditionalProp { get; set; }
}

[TestMethod]
public void SpecificTypeJsonConverterTest()
{
    ITestObject itestObject = JsonSerializer.Deserialize<ITestObject>("""{ "Id": 1337, "AdditionalProp": "Test" }""")!;
    itestObject.ShouldBeOfType<TestObject>(o =>
    {
        o.Id.ShouldBe(1337);
        o.AdditionalProp.ShouldBe("Test");
    });
    JsonSerializer.Serialize(itestObject).ShouldBe("""{"Id":1337,"AdditionalProp":"Test"}""");
}

Commonly Used Types

• JsonExtensionObject
• SpecificTypeJsonConverter