Raise json validation error on invalid json using .net core json model binding

Question

I have some simple controllers that uses .net core model binding for creating an entity using json input.

When sending invalid json (json, that couldn't be parsed correctly because of a typo or missing escape) user will be null and a not usefull error will be thrown.

How could I raise a json validation error and return the information, that json is malformed to the api caller?

[HttpPost]
[ProducesResponseType(typeof(User), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(HttpErrorResponse), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> Post([FromBody]User user)
{
    return Ok(this.userService.CreateNewUser(user));
}

Sander Homan · Accepted Answer · 2020-03-16 09:28:12Z

1

There are 2 things that can be done:

First, if it is an API then use the ApiController attribute instead of the Controller attribute. This will handle the model state/parsing error handling for you.

The other option is the check ModelState.IsValid. e.g.

public async Task<IActionResult> Post([FromBody]User user)
{
    if(!this.ModelState.IsValid)
       return BadRequest(this.ModelState);
    return Ok(this.userService.CreateNewUser(user));
}

The first option has my preference. Also because it seems that it produces a better error in case of invalid json.

answered Mar 16, 2020 at 9:28

Sander Homan

893 bronze badges

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

Collectives™ on Stack Overflow

Raise json validation error on invalid json using .net core json model binding

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related