在Web API中传递枚举参数的最佳实践

Question

我有一个RESTful Web API项目，我有2个不同的Enum场景，我不确定是最佳实践。

场景1：简单的枚举参数

我的API方法需要一个名为ruleType的参数，有效值为EmailAddress和IPAddress。Web API项目中的枚举如下所示：

public enum RuleType
{
    None = 0,
    EmailAddress = 1,
    IPAddress = 2
}

我对这个场景的问题是，我应该使用＜code＞吗？ruleType=EmailAddress（它会自动将该值绑定到API方法中的ruleTypeproperty）？如果是，如何最好地验证发送的＜code＞RuleType＜/code＞参数是否为有效的RuleType枚举值？

场景2：单个参数的多个枚举值

我的 API 方法有一个可选字段参数，它允许您指定应返回的任何其他数据。例如

我在Web API项目中有一个枚举，它与可能请求的每个可能的＜code＞字段＜/code＞相关，目前，我正在拆分逗号分隔的字段param，然后循环该枚举的每个字符串表示，将其解析为等效的枚举，从而生成一个枚举值列表，然后我可以在API中使用该列表来检索相关数据。

这是枚举:

public enum OptionalField
{
    None = 0,
    RuleOwner = 1,
    Rule = 2,
    etc.
}

这里的最佳做法是什么？我正在研究按位枚举，所以在API请求中发送了一个值，这导致了字段的任意组合，但我不知道这是否适用于Web API，或者是否有更好的方法来实现这一点？




Answer 1

对于方案 2，C# 中内置了对使用 [Flags] 属性的枚举中的位掩码操作的支持

[Flags]
public enum OptionalField
{
    None = 0,
    RuleOwner = 1,
    Rule = 2,
    RuleAdministrator = 4,
    RuleEditor = 8,
    ...etc
}

这在这篇SO帖子中有所描述

正如Christian在他的回答中已经说过的那样，在REST API中使用它可能不是好的做法，但它应该可以工作。

Answer 2

最好的做法是使URI“可读”。所以我也能理解为什么使用Enum作为字符串。但正如赫里斯托·科列夫所说，你必须编写一个自定义模型活页夹。

在字段中，我认为不应该使用枚举的组合。因为这很难理解。也许您可以将enum组合创建为enum条目

public enum OptionalField
{
    None = 0,
    RuleOwner = 1,
    Rule = 2,
    RuleAndRuleOwner = 3,
    etc.
}

Answer 3

最简单的答案是，“没关系”。

如果控制器方法中的参数是枚举类型

public IHttpActionResult Foo(RuleType ruleType)

在 WebAPI 中，它只是工作 - 无论客户端请求 URL 将参数值指定为 ？ruleType=1 还是 ？ruleType=EmailAddress

如果客户端指定的值对枚举无效，则会引发异常（参数字典包含方法“Foo”的不可为null类型“ruleType”的参数“ruleType”为null条目…，并且客户端会得到400错误请求响应。