5

我想在 .net 4.5 上使用 ASP.net WebApi 创建一个 REST Web 服务

网址应该是这样的格式:

/values?Age=55&Height=176&Race=1&Weight=80&Gender=male&id=800001

关联的控制器如下所示:

[HttpGet]
public string Get(int id, [FromUri]Demographics demographics)
{ // etc.}

其中 Demographics 是一个自定义对象,基本上只是具有某些属性的 DTO。但是,它包含一个具有自定义枚举类型的属性:

enum Gender
{
 Female = 0,
 Male
}

如果 URL 采用上述格式,默认映射就可以正常工作。但是,当然我还需要检查url提供的参数是否正确。

默认情况下,ASP.net WebApi (afaik) 尝试根据假定的类型(或者是否可以将其转换为该类型)映射每个参数。如果它在 URI 中找不到匹配的值,它似乎假设它只是 0。

现在这把我带到了一个非常不幸的情况,其中 0 根据定义仍然是 Gender Demographics.Gender (0 ~ Gender.Female) 的有效值。

最简单的解决方案是更改枚举,使 0 成为我可以检查的“不确定”状态。但是,我无法更改枚举。我可以为 Demographics 对象创建自己的重载,但不想这样做,因为我认为必须有更好的方法。

我可以将性别参数显式绑定到 URI 中的参数并在未提交时抛出异常吗?

我阅读了有关类型转换器的信息,但我必须处理 URI 字符串,并认为我必须实现 WebApi 显然已经拥有的很多功能。

请记住,我必须处理 URI 并且不能使用请求正文。

4

2 回答 2

4

像这样使枚举可以为空怎么样?

public class Demographics
{
    public Gender? Gender { get; set; }
}

在 action 方法中,您可以检查是否demographics.Gender为空。

于 2013-08-07T14:17:24.030 回答
1

WebAPI 包含一个通过 数据注释的验证框架。这允许您将 Demographics 对象中的性别属性标记为 [必需]:

public class Demographics
{
    [Required]
    public Gender Gender { get; set; }
}

然后,使用 [ValidateModel] 属性标记控制器或控制器方法以强制验证(阅读其他强制验证的方法,例如全局:模型验证):

[HttpGet]
[ValidateModel]
public string Get(int id, [FromUri]Demographics demographics)
{ // etc.}

在此之后,如果您错过提供参数,您将获得自动验证和错误 400 Bad Request 并显示以下消息:

{"Message":"The request is invalid.","ModelState":{"Gender":["The Gender field is required."]}}

默认情况下,即使没有 required 属性,也会正确处理无效值,因此提供给性别的不正确 Foo 值也会以 400 Bad Request 消息响应:

{"Message":"The request is invalid.","ModelState":{"Gender":["The value 'Foo' is not valid for Gender."]}}
于 2015-12-17T19:27:39.493 回答