ModelStateExtensions 1.0.5

dotnet add package ModelStateExtensions --version 1.0.5                
NuGet\Install-Package ModelStateExtensions -Version 1.0.5                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ModelStateExtensions" Version="1.0.5" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ModelStateExtensions --version 1.0.5                
#r "nuget: ModelStateExtensions, 1.0.5"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ModelStateExtensions as a Cake Addin
#addin nuget:?package=ModelStateExtensions&version=1.0.5

// Install ModelStateExtensions as a Cake Tool
#tool nuget:?package=ModelStateExtensions&version=1.0.5                

Features

An extension to help you get the error messages from your ASP.NET API Model errors.

How to use

When you receive data using a model from the body of an API request, you want to validate if the data is correct to proceed with the request. When you check the state of your model and you get an invalid return, you can use this extension to get the errors.

Note: the ModelState must be a Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary

Getting all error messages as a list:

To get all the error messages from your model, use the GetErrors extension so you can have a list with all the messages:

public async Task<IActionResult> CreateAccount([FromBody] RegisterViewModel model)
{
   if (!ModelState.IsValid)
      return BadRequest(ModelState.GetErrors());
      //Calls the extension method GetErrors to return the list of errors

Getting the first error message:

"If you need to get only a single error message, you can use the GetFirstError extension. Using this function, you'll get the first error found from your model:

public async Task<IActionResult> CreateAccount([FromBody] RegisterViewModel model)
{
   if (!ModelState.IsValid)
      return BadRequest(ModelState.GetFirstError());
      //Calls the extension method GetFirstError to return the first error message found
Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.5 137 2/21/2024
1.0.4 241 11/1/2023
1.0.3 256 2/23/2023
1.0.2 234 2/21/2023
1.0.1 226 2/21/2023
1.0.0 233 2/20/2023