JsonPatchBind 0.0.1

= JsonPatchBind

A lightweight library for handling partial updates in ASP.NET Core APIs without JSON Patch.

Description

When building APIs for partial updates (PATCH requests), developers often face challenges such as:

• Differentiating between an explicit null and an omitted field. • Avoiding overwriting fields that were not sent by the client. • Ensuring accurate schema documentation with Swagger/Swashbuckle.

JsonPatchBind elegantly addresses these challenges by introducing the Optional<T> type.

Key Benefits:

• Field Presence Tracking: Determine if a property was included in the JSON payload (even if its value is null). • Safe Updates: Update only the fields provided in the request, leaving others unchanged. • Native JSON Integration: Seamless serialization/deserialization via System.Text.Json. • Swagger Support: Automatic schema generation for Optional<T> fields.

Features

✅ Optional<T> Wrapper: - HasValue = true → Field was sent (value can be null). - HasValue = false → Field was omitted.

✅ Custom JSON Converter: Serializes/deserializes Optional<T> correctly while handling nulls.

✅ Swagger Schema Filter: Displays Optional<T> as nullable fields in OpenAPI documentation.

✅ ASP.NET Core Integration: Works seamlessly with [FromBody] model binding.

✅ No External Dependencies: Built using standard .NET components.

Why Not JSON Patch?

Although JSON Patch (RFC 6902) is a standard, it comes with several drawbacks:

❌ Clients must send complex operations (replace, remove, add).

❌ It overcomplicates simple partial updates.

❌ It demands extra validation.

= Сomparison Table: When to Use

= Pros and Cons: JSON Patch vs. JsonPatchBind

= When to Use JsonPatchBind?

Use JsonPatchBind if:

• You need to implement partial updates without overcomplicating your logic.

• You require precise tracking of which fields were sent by the client.

• You want to minimize extra validation and work seamlessly with OpenAPI/Swagger.

• You do not need the full set of JSON Patch operations.

= Installation & Integration

1. Installation: Add the package to your project via NuGet:

   dotnet add package JsonPatchBind
   

2. Usage in a Controller: Example model:

   public class UpdateUserModel
   {
       public Optional<string> FirstName { get; set; }
       public Optional<string> LastName { get; set; }
       public Optional<string> Email { get; set; }
   }