marusyk / simple.httppatch

Simple.HttpPatch implementation for .NET to easily allow & apply partial REST-ful service (through Web API) using Http Patch

Simple.HttpPatch

Simple.HttpPatch is implementation for .NET (Full framework and Core) to easily allow & apply partial RESTful service (through Web API) using HTTP PATCH method.

Installation

You can install the latest version via NuGet.

PM> Install-Package Simple.HttpPatch

How to use

See samples folder to learn of to use this library with ASP.NET Core.

Patch a single entity

[HttpPatch]
public Person Patch([FromBody] Patch<Person> personPatch)
{
    var person = _repo.GetPersonById(1);
    personPatch.Apply(person);
    return person;
}

To exclude properties of an entity while applying the changes to the original entity use PatchIgnoreAttribute. When your property is a reference type (which allows null) but you don't want that null overwrites your previous stored data then use PatchIgnoreNullAttribute

public class Person
{
    public int Id { get; set; }
    [PatchIgnore]
    public string Name { get; set; }
    public int? Age { get; set; }
    [PatchIgnoreNull]
    public DateTime BirthDate { get; set; }
}

Note: The property with name Id is excluded by default

For firewalls that don't support PATCH see this issue

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

simple.httppatch's Issues

Add support PUT with a header override for firewalls that don't support PATCH

https://www.hanselman.com/blog/HTTPPUTOrDELETENotAllowedUseXHTTPMethodOverrideForYourRESTServiceWithASPNETWebAPI.aspx

Ignore null value for specified properties

This is particularly useful in two cases:

• when your property is a value type (like int and DateTime) and your client still send a null value for that property. Ignoring null value will avoid exception.

• when your property is a reference type (which allows null) but you don't want that null overwrites your previous stored data.

Prepare config to pack and publish NuGet package

Need to prepare config to publish NuGet package from artifacts folder

Tips, improvements, suggestions

It would be great to have some suggestions how it can be improved. Maybe some ideas for new features.

.net 5 & C# 9

Add support Patch for collections

Currently the Patch supports only primitive types. It is nice to have possibility patch arrays and collections

Add possibility to create Patch model

Currently we have

[HttpPatch]
public Person Patch([FromBody] Patch<Person> personPatch)
{
    var person = _repo.GetPersonById(1);
    personPatch.Apply(person);
    return person;
}

So, creating of Patch model is doing by Model Binder.
It would be nice to have possibility to create it manually:

[HttpPatch]
public void Patch([FromBody] Patch<Person> personPatch)
{
    var personPatch = new Patch<Person>(personDto)
    var person = _repo.GetPersonById(1);
    personPatch.Apply(person);
    return person;
}

Upgrade to .NET 6

Tips, improvements, suggestions

It would be greate to have some suggestions how it can be improved. Maybe some ideas for the new features.

Excluding properties

Nice to have possibility to exclude one or more properties of an entity while applying the changes to the original entity to preserve the original value of the property.

Add unit tests for Patch class

Need to add some unit test on Patch class that derived from DynamicObject

The TrySetMember method is not working; it doesn't execute.

• The TrySetMember method never executes; therefore, _changedProperties remains empty, and as a result, it doesn't work.
• I tried with the example from the repository, and I get the same results; it doesn't work.
• Thank for your time :).