پاس دادن Enum به عنوان ورودی به HTTP GET

در صورتی که می‌خواهید یک Enum را به یکی API که بصورت HTTPGET است، پاس بدهید، حواستان باشد که بصورت پیش فرض معتبر بودن ورودی آن بررسی نمی‌شود.
بطور مثال کد زیر را درنظر بگیرد:

[HttpGet]
public async Task<ApiResult<List<ResultVm>>> GetPublicWatchItems(MyEnum watch)

public enum MyEnum
{
	[Description("بیشترین تاثیر")]
	MaxIndexAffect = 1,

	[Description("بیشترین حجم")]
	MaxVolumeAmount = 2,
}

در صورتی که مقادیر زیر را به آن پاس بدهید که در حالت اول نام اشتباه است و در حالت دوم مقدار معتبر نیست، با خطا مواجه نمی‌شوید و برنامه به کار خود ادامه می‌دهد.

api/MyController/GetPublicWatchItems?id=2
api/MyController/GetPublicWatchItems?watch=0

در Enum ها دقت کنید که مقدار پیشفرض آن همیشه 0 است، حتی اگر شبیه به enum بالا اصلا مقدار صفر در آن نباشد.

var e = default(MyEnum);
Console.WriteLine(e);

پس یا باید مقدار آن را بررسی کنید و یا از [Required] استفاده کنید.

[HttpGet]
public async Task<ApiResult<List<ResultVm>>> GetPublicWatchItems([Required] MyEnum watch)

روش دوم:

[HttpGet("{watch}")]
public async Task<ApiResult<List<ResultVm>>> GetPublicWatchItems(MyEnum watch)

که در این حالت ورودی باید بصورت زیر باشد که اگر مقدار آن داده نشود با خطا مواجه می‌شوید.

api/MyController/GetPublicWatchItems/2

اطلاعات بیشتر:

ca1008

default-values

enum