Enumeration Pattern / Class

Based on this article

A more Robust version which allows for different data types for the Id and to change the case types based on based text.

Json Conversion

To add the Enumeration Converter into Json Serialization

var options = new JsonSerializerOptions()
{
	Converters = {new JsonStringConverterFactory(StringCase.camelCase)}
};

Add Enumeration Conversion Web Api Json Responses and Request as Default

builder.Services.ConfigureHttpJsonOptions(options =>
{
	options.SerializerOptions.Converters.Add(new JsonStringEnumerationConvertFactory(StringCase.CamelCase));
});
builder.Services.Configure<JsonOptions>(options =>
{
	options.SerializerOptions.Converters.Add(new JsonStringEnumerationConvertFactory(StringCase.CamelCase));
});

For the special cases that use a different conversion use

public  IActionResult Get()
{
	var options= new JsonSerializerOptions()
	{
		converters = {new //your custom converter here or enumeration converter factory}
	};

	return new JsonResult(response, options);
}

Swagger

Add Swagger Schema filter for Enumeration Class to the add swaggerGen options

builder.Services.AddSwaggerGen(options => 
{
	// set which case swagger will use in the parameter
	options.SchemaFilter<SwaggerEnumerationSchemaFilter>(StringCase.CamelCase)
})

However Swagger still needs IParsable<TSelf> or ModelBinder to be implemented to display the dropdowns. The Controller will still work if called directly

IParsable<TSelf> can be implemented on each class

The Method Below can be copied and pasted into all derived classes

public static (EnumerationClass) Parse(string s, IFormatProvider? provider)
{
	if (TryParse(s, null, out var result))
			return result;

		var className = MethodBase.GetCurrentMethod()?.DeclaringType?.Name ?? "Unknown ClassName";
		throw new InvalidOperationException($"Unable to parse string, {className}");
}

public static bool TryParse([NotNullWhen(true) string? s, IFormatProvider? provider, [MaybeNullWhen(false)] out (EnumerationClass) result)
{
	return TryParse(s, out result);
}

OR

Be done Morphic that can been seen on the EnumerationParsable class in the swagger folder. This is implemented by the PaymentType Model found in the WebDemo.

Also included is an example using ModelBinder.

Data Layer

TO DO show examples of how use Enumeration Pattern / class on the data layer

Entity Framework

Added the OnCreatingModel Entity Conversion which shows how to convert the Enumeration Class to use the ID for CRUD operations.

    modelBuilder.Entity<SimpleModel>(entity =>
    {
      entity.HasKey(x => x.Id);

      // add conversion to use Workflow status when stored in database
      entity.Property(p => p.Status)
        .HasConversion
        (
          c => c.Id,
          c => WorkflowStatus.FromId<WorkflowStatus>(c)
        );
    });

MongoDb

Created a simple a unit test using Mongo2Go and InMemory Database for Mongo.

Created a custom EnumerationBsonSerializer and EnumerationBsonSerializer Provider that will store the case string as the value instead of the whole class.