Model Validation With Web API and JSON Patch Document

Question

I'm using JsonPatchDocument with ASP.NET 4.5 and Web Api. My controller looks like this:

[HttpPatch]
[Route("MyRoute/{PersonItem1}/{PersonItem2}/")]
public IHttpActionResult ChangePerson([FromHeader]Headers, [FromBody]JsonPatchDocument<PersonDto> person)
{
    // Do some stuff with "person"
}

And PersonDto:

public class PersonDto
{
    public string Name { get; set; }
    public string Email { get; set; }
}

Now, I may send a PATCH request that is something like:

{
    "op": "op": "replace", "path": "/email", "value": "[email protected]"
}

Now let's say I add some data annotations:

public class PersonDto
{
    public string Name { get; set; }

    [MaxLength(30)]
    public string Email { get; set; }
}

What is the best way to ensure this validation is honored without writing additional validation. Is it even possible?

Betsalel Williamson · Accepted Answer · 2016-12-12 20:53:23Z

4

There is the simple method:

Get your object from your repository.
Deep copy the object so you have object A and B.
Apply the change with person.ApplyUpdatesTo(objB).
Create an extension method to validate the difference between object A and B.
If the validation is good proceede, if not throw an error.

This would catch if the client was attempting to modify immutable fields or if the new information in object B violates your constraints.

Note that this is not a great solution in that you would have to change your code in two places if you happen to change your constraints.

answered Dec 12, 2016 at 20:53

Betsalel Williamson

1311 silver badge11 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Jamie Counsell Over a year ago

Thanks! I am looking for something like a filter that would not require me to write such code in each controller, but this is a good start.

Collectives™ on Stack Overflow

Model Validation With Web API and JSON Patch Document

1 Answer 1

1 Comment

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Related