无界的分层路线

时间:2016-08-27 18:10:21

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

我想使用webapi来公开这样的分层键值数据结构:

http://www.whatever.com/api/root/level1/level2/leveln

这可以用webapi吗?如果是这样,怎么样?

1 个答案:

答案 0 :(得分:1)

WebApi几乎可以公开您喜欢的任何URI - 它取决于您如何配置路由,以及在从URL中提取方法参数后如何解释它们。

要映射无界的分层路由,我会将/api/root/之后的所有内容映射到单个变量,然后在控制器或专用服务的自定义逻辑中显式解析和解释该方法。

获得匹配的技巧包括正斜杠是在开头添加*

config.Routes.MapHttpRoute(
    name: "KeyValueHierarchy",
    routeTemplate: "api/test/root/{*keyLevels}",
    defaults: new { controller = "Hierarchy" }
);

然后在控制器中

public class HierarchyController : ApiController
{

    public IHttpActionResult Get(string keyLevels)
    {
        var keys = keyLevels.Split('/');

        // ... do stuff with your keys

        return Ok(keys);
    }

}

快速测试:

GET /api/test/root/foo/5/bar/10/foobar

返回:

<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>foo</string>
  <string>5</string>
  <string>bar</string>
  <string>10</string>
  <string>foobar</string>
</ArrayOfstring>