Web API路由协助

时间:2012-11-30 00:06:50

标签: asp.net-web-api asp.net-mvc-routing

学习很多关于MapRouting的知识,花了太多时间试图得到我需要的东西,所以我希望有人可以提供帮助。 :)

我希望做到以下几点:

/ api / Entities / 1< - 查看id为1 的详细信息实体(这是一个字符串,而不是int)

/ api / Entities / 1 / Action< - 在id为1的实体上调用特定操作。

/ api / Entities< - 查看实体集。

/ api / Entities / Action< - 在实体集上调用特定操作。

我遇到的问题是最后一个问题。目前正在被第一种情况截获,因为id是一个字符串。

非常感谢任何帮助!

1 个答案:

答案 0 :(得分:2)

非常好的参考是here

在不使用Attribute based routing的情况下,答案有点冗长,因为如果您匹配同一个动词,RPC样式(Action)和Rest方法不能很好地共存。正如您所注意到的那样,GET()和DOSOMETHING()被视为同一控制器上的重复方法签名。要解决这个问题,您可以尝试使用两个控制器:

所以我建议使用attribute based路由;但是,通过常规方法可以实现:

使用标准路由...

设置您的路线

        config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
        config.Routes.MapHttpRoute(
            name: "ActionDefaultApi",
            routeTemplate: "api/entities/{action}/{actionId}",
            defaults: new
                          {
                              //Add more as needed
                              action = "(|dosomething|dosomethingelse)",
                              actionId = RouteParameter.Optional,
                              controller = "EntitiesRpc"
                          });

控制器1:

public class EntitiesController : ApiController
{
    public string Get()
    {
        return "http://server/api/Entities";
    }

    public string Get(string id)
    {
        return string.Format("http://server/api/Entities/{0}", id);
    }
}

控制器2:

public class EntitiesRpcController : ApiController
{
    [HttpGet]
    public string DoSomething()
    {
        return "http://server/api/Entities/doSomething";
    }

    [HttpGet]
    public string DoSomething(string actionId)
    {
        return string.Format("http://server/api/Entities/doSomething/{0}", actionId);
    }

    [HttpGet]
    public string DoSomethingElse()
    {
        return "http://server/api/Entities/doSomethingelse";
    }

    [HttpGet]
    public string DoSomethingElse(string actionId)
    {
        return string.Format("http://server/api/Entities/doSomethingelse/{0}", actionId);
    }
}

现在假设你使用了基于属性的路由,你可以回到一个控制器并使用这样的东西:

public class EntitiesController : ApiController
{
    [Get("Entities")]
    public string Get()
    {
        return "http://server/api/Entities";
    }

    [Get("Entities/{id}")]
    public string Get(string id)
    {
        return string.Format("http://server/api/Entities/{0}", id);
    }

    [Get("Entities/doSomething")]
    public string DoSomething()
    {
        return "http://server/api/Entities/doSomething";
    }

    [Get("Entities/doSomething/{actionId}")]
    public string DoSomething(string actionId)
    {
        return string.Format("http://server/api/Entities/doSomething/{0}", actionId);
    }

    [Get("Entities/doSomethingelse")]
    public string DoSomethingElse()
    {
        return "http://server/api/Entities/doSomethingelse";
    }

    [Get("Entities/doSomethingelse/{actionId}")]
    public string DoSomethingElse(string actionId)
    {
        return string.Format("http://server/api/Entities/doSomethingelse/{0}", actionId);
    }
}