Byndyusoft.ValidEnumConverter

Byndyusoft.ValidEnumConverter

Custom JsonConverter for enums with value validation.

Byndyusoft.ValidEnumConverter

Installing

dotnet add package Byndyusoft.ValidEnumConverter

Usage

Byndyusoft.ValidEnumConverter designed to properly validate numbers in a string. The System.Text.Json.Serialization library does not correctly validate numbers in a string like "Enum" For example: We have our own enum, let's call it UserRole:

public enum UserRole
{
    Administrator = 0,
    Agent = 1
}

And there is a Dto object:

public UserInfoDto 
{
    public int Id {get; set; }
    public UserRole Role {get; set; }
}

When using this Dto object in our controller as an accepted class On the front side, the following Json can be sent:

{
  "Id": 1,
  "UserRole": "589"
}

The non-existent value of our UserRole, it is logical to assume that a regular validator should throw an error with a code of 400, but this does not happen. Therefore, we decided to make our own custom converter. Which validates the numbers in the string correctly

how to use the converter We go to the Setup.cs of our project:

services.AddControllers ()
    .AddJsonOptions (options => ...

and add following line

options.JsonSerializerOptions.Converters.AddValidEnumConverter();

After that, all Enum types are correctly converted for you.

Contributing

To contribute, you will need to setup your local environment, see prerequisites. For the contribution and workflow guide, see package development lifecycle.

A detailed overview on how to contribute can be found in the contributing guide.

Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:

• Git - Download & Install Git. OSX and Linux machines typically have this already installed.
• .NET Core (version 3.1 or higher) - Download & Install .NET Core.

Package development lifecycle

• Implement package logic

Maintainers

[email protected]