Woody230.BindableEnum 3.0.0

BindableEnum

Provides an enumeration wrapper that holds whether binding from the original string is successful.

This is useful when automatic model state validation needs to be disabled so that validation can be postponed to a later point in time.

Normally a bad enum will cause the binding to fail, even though it would be preferrable to check for this in the postponed validation.

With the bindable enum this is avoided, while also providing the convenience of automatically handling the conversion to an enum that would otherwise be missing when reverting back to using a string within a model.

Setup

Program.cs

Configure the BindableEnumSwaggerGenOptions on the service collection.

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Woody230.BindableEnum.Options;

var builder = WebApplication.CreateBuilder(args);
builder.Services.ConfigureOptions<BindableEnumSwaggerGenOptions>();

This will map the BindableEnum generic type definition with an OpenApiSchema type of string.

Also, the BindableEnumSchemaFilter is applied in order to add the enumerations to the OpenApiSchema.

Model

When declaring your bindable enumeration, you can use the BindedEnumAttribute to validate that the enumeration has been successfully binded.

Note that a null bindable enumeration is NOT validated. The RequiredAttribute must be added to support this.

using System.ComponentModel.DataAnnotations;
using Woody230.BindableEnum.Attributes;
using Woody230.BindableEnum.Models;

public record WeatherForecast
{
    [Required]
    [BindedEnum]
    public IBindableEnum<DayOfWeek> DayOfWeek { get; set; }
}    

Extensions

If you are using the interface IBindableEnum{T}, you can use the Bindable() extension method to convert an enumeration into a IBindableEnum{T}.

using System;
using Woody230.BindableEnum.Models;

IBindableEnum<DayOfWeek> dayOfWeek = DayOfWeek.Sunday.Bindable();

If you are using the implementation BindableEnum{T}, then there is an implicit conversion between the enumeration and the BindableEnum{T} in both directions.

using System;
using Woody230.BindableEnum.Models;

BindableEnum<DayOfWeek> dayOfWeek = DayOfWeek.Sunday;