将枚举参数传递给WebApi方法

时间:2019-03-01 09:20:44

标签: c# asp.net-web-api asp.net-web-api-routing

试图将枚举类型值传递给WebApi,但它接受除枚举整数以外的任何值。

我们可以限制只接受枚举值吗?

public class ValuesController : ApiController
{
    [HttpGet]
    [Route("api/getName/{Gender}")]
    public IEnumerable<string> Get(Gender gender)
    {
        Gender g = gender;

        return new string[] { "value1", "value2" };
    }
}

枚举值

public enum Gender
{
    Male,
    FeMale
}

例如:

  1. http://localhost:58984/api/getName/1-解析为FeMale
  2. http://localhost:58984/api/getName/6-它接受6,但我想抛出一个异常。

1 个答案:

答案 0 :(得分:1)

您必须手动检查,ASP.NET MVC却不适合您:

Type enumType = gender.GetType();
bool isEnumValid = Enum.IsDefined(enumType, gender);
if (!isEnumValid) {
  throw new Exception("...");
}

除了抛出异常,您还可以在模型上使用验证器来检查枚举是否正确。

之所以通过参数传递无效的枚举,是因为枚举是整数,here进行了解释。