使用 RESTFUL 时，如何添加具有不同输入参数的多个 Get 操作？

Question

我正在尝试找出在 REST 控制器中拥有多个 Get 操作的最佳方式。

我想做这样的事情：

按 ID 获取：

public ResponseType Get(Guid id)
{
   // implementation
}

通过枚举类型获取：

public ResponseType Get(EnumType type)
{
   // implementation
}

通过其他枚举类型获取：

public ResponseType Get(OtherEnumType otherType)
{
   // implementation
}

等等。

现在，当我执行类似操作时，会收到下一条错误消息：

Multiple actions were found that match the request

我明白为什么我会收到这条消息，并且我在想最好的方法是如何做这样的事情（我想坚持使用 REST）。

我知道我可以添加这样的路线：

routeTemplate: "api/{controller}/{action}/{id}"

但是我需要更改动作名称和网址 - 当我们谈论休息时，这似乎是一种解决方法。

我想到的另一件事是用一个 Get 创建多个控制器 - 但这似乎更错误。

第三种解决方法是使用具有以下状态的输入参数处理一个 Get 操作：

public ResponseType Get(ReqeustObj obj)
{
   switch(obj.RequestType)
   {
        case RequestType.GetById:
        // etc...
   }
}

无论如何，我想知道在 REST (WebApi) 中执行类似操作的最佳方法是什么。

Answer 1

正如你现在，当 Web API 需要选择一个动作时，如果你没有在路由中指定动作名称，它会查找名称以方法名称开头的动作，在这种情况下是 GET。所以在你的情况下，它会找到多种方法。

但它也尝试匹配参数。因此，如果您将参数作为 url（路由参数）或查询字符串的一部分包含在内，则操作选择器将能够选择一种可用的方法。

如果您没有指定参数或在 url（甚至在查询字符串中）指定 id，它应该调用第一个重载。如果像这样在查询字符串中添加第二个动作的参数名称：?type=VALUE 应该选择对应的重载，以此类推。

问题是参数名称必须不同，否则将无法在所有重载中选择一个。

例如，如果您在浏览器中使用 cmets 中的 url，您将看到如何选择正确的方法：

public class TestController : ApiController
{
    // GET api/Test
    public string Get()
    {
        return "without params";
    }

    // GET api/Test/5
    public string Get(int id)
    {
        return "id";
    }

    // GET api/Test?key=5
    public string Get(string key)
    {
        return "Key";
    }

    // GET api/Test?id2=5
    public string Get2(int id2)
    {
        return "id2";
    }
}

注意：您也可以使用路由约束来调用不同的方法，而无需使用查询字符串参数，而是使用不同的约束定义不同的路由参数名称。例如，您可以为 id 添加一个仅接受数字 "\d+" 的约束，然后在所有其他情况下添加第二个接受 "key" 的路由。这样可以避免使用查询字符串