JsonPact.System 0.0.3

🤝 json-pact

json wrapper library that enforces casing & validates required properties by checking if the property uses the nullable ? property marker as specified by nullable value types and also makes use of optional values without the need for extra attributes.

💪 Extending

• Newtonsoft
• System.Text.Json

[JsonPact(JsonPactCase.Snake)]
public record JsonDTO(
    string RequiredValue,
    string? NullableValue,
    string OptionalValue = "default"
);

// vs

[JsonObject(NamingStrategyType = typeof(SnakeCaseNamingStrategy))]
public record JsonDTO(
    [property: JsonProperty(Required = Required.Always)]
    string RequiredValue,
    string? NullableValue,
    [property: DefaultValue("fallback")]
    string OptionalValue
);

🥽 Prerequisites

You will need to enable the nullable project setting within your projects .csproj file.

<PropertyGroup>
    
    <Nullable>enable</Nullable>
</PropertyGroup>

Install

Newtonsoft

dotnet add package JsonPact.Newtonsoft

System.Text.Json

dotnet add package JsonPact.System

🏎️💨 Getting Started

[JsonPact]
public record JsonDTO(
    string RequiredValue,
    string? NullableValue,
    string OptionalValue = "default"
);

Here we define the schema with a required value RequiredValue with rest of the values NullableValue & OptionalValue defined as default-able properties.

So if the RequiredValue is found missing an error will be thrown and default-able values will be automatically defaulted.

var pact = JsonPacts.Default(JsonPactCase.Snake).IntoJsonPact();

var json = pact.Serialize(new JsonDTO("required", null));
// = { "required_value": "required", "optional_value": "default" }

var obj = pact.Deserialize<JsonDTO>(json);
// = JsonDTO("required", null, "default")

var err = pact.Deserialize<JsonDTO>("{ }");
// = JsonPactDecodeException

⚙️ Settings

SetupJsonPact settings along with your own Newtonsoft settings.

var settings = new NewtonSoft.JsonSerializerSettings { 
 // ...
}.AddJsonPact(JsonPactCase.Camel);

var pact = settings.IntoJsonPact(); 

🎮 Overriding casing

If you are dealing with mixed casing you can provide a casing type with the JsonPact attribute, this will override the default casing and will allow you to have nested objects with different casing.

[JsonPact(JsonPactCase.Snake)]
public record Snake(Camel RequiredValue);

[JsonPact(JsonPactCase.Camel)]
public record Camel(Kebab RequiredValue);

[JsonPact(JsonPactCase.Kebab)]
public record Kebab(string RequiredValue);

var pact = JsonPacts.Default(JsonPactCase.Snake).IntoJsonPact();

var snake = new Snake(new Camel(new Kebab("hello")));

var json = pact.Serialize(snake);
// = { "required_value": { "requiredValue": { "required-value": "hello" } } }

⚠️ Currently nested objects with different casing while using System.Text.Json will not work as shown above only the top level JsonPact attribute is respected but it will work perfectly with Newtonsoft.