MVC3 RESTful API 路由和 Http 动词处理

我想为我的 MVC3 应用程序构建 RESTful Json Api。我需要帮助处理多个 Http Verbs 以操作单个对象实例。

我读过/研究过/尝试过的内容

MVC 属性（HttpGet, HttpPost等）允许我拥有一个具有多个共享相同名称的操作的控制器，但它们仍然必须具有不同的方法签名。

路由约束发生在路由模块中beforeMVC 启动后会导致我有 4 个显式路由，并且仍然需要单独命名的控制器操作。

ASP.NET MVC AcceptVerbs 和注册路由 https://stackoverflow.com/questions/283209/asp-net-mvc-acceptverbs-and-registering-routes

构建自定义 Http Verb 属性可用于获取用于访问操作的动词，然后在调用操作时将其作为参数传递 - 然后代码将处理 switch 情况。这种方法的问题是某些方法需要授权，这些授权应该在操作过滤器级别处理，而不是在操作本身内部处理。

http://iwantmymvc.com/rest-service-mvc3 http://iwantmymvc.com/rest-service-mvc3

要求/目标

1. 单个实例对象的一个​​路由签名，MVC 预计会处理四个主要的 Http Verb：GET、POST、PUT、DELETE。

   context.MapRoute("Api-SingleItem", "items/{id}", 
       new { controller = "Items", action = "Index", id = UrlParameter.Optional }
   );
   

2. 当 URI 未传递 Id 参数时，操作必须处理POST and PUT.

   public JsonResult Index(Item item) { return new JsonResult(); }
   

3. 当 Id 参数传递到 URI 时，单个操作应该处理GET and DELETE.

   public JsonResult Index(int id) { return new JsonResult(); }
   

Question

我怎样才能有多个操作（共享相同的名称和方法签名），每个操作都响应一个唯一的 http 动词。所需的示例：

[HttpGet]
public JsonResult Index(int id) { /* _repo.GetItem(id); */}

[HttpDelete]
public JsonResult Index(int id) { /* _repo.DeleteItem(id); */ }

[HttpPost]
public JsonResult Index(Item item) { /* _repo.addItem(id); */}

[HttpPut]
public JsonResult Index(Item item) { /* _repo.updateItem(id); */ }

对于 RESTful 调用，该操作没有任何意义，因为您只想通过 HTTP 方法进行区分。因此，技巧是使用静态操作名称，以便控制器上的不同方法仅在它们接受的 HTTP 方法上有所不同。

虽然MVC框架提供了指定action名称的解决方案 https://stackoverflow.com/questions/6348372，它可以变得更加简洁和不言自明。我们是这样解决的：

特殊属性用于指定 RESTful 方法（这与特殊操作名称匹配）：

public sealed class RestfulActionAttribute: ActionNameSelectorAttribute {
    internal const string RestfulActionName = "<<REST>>";

    public override bool IsValidName(ControllerContext controllerContext, string actionName, MethodInfo methodInfo) {
        return actionName == RestfulActionName;
    }
}

控制器将其与 HTTP 方法属性结合使用：

public class MyServiceController: Controller {
    [HttpPost]
    [RestfulAction]
    public ActionResult Create(MyEntity entity) {
        return Json(...);
    }

    [HttpDelete]
    [RestfulAction]
    public ActionResult Delete(Guid id) {
        return Json(...);
    }

    [HttpGet]
    [RestfulAction]
    public ActionResult List() {
        return Json(...);
    }

    [HttpPut]
    [RestfulAction]
    public ActionResult Update(MyEntity entity) {
        return Json(...);
    }
}

为了成功绑定这些控制器，我们使用带有前面提到的属性中的静态操作名称的自定义路由（同时也允许自定义 URL）：

routes.MapRoute(controllerName, pathPrefix+controllerName+"/{id}", new {
    controller = controllerName,
    action = RestfulActionAttribute.RestfulActionName,
    id = UrlParameter.Optional
});

请注意，据我所知，这种方法可以轻松满足您的所有要求；您可以在一种方法上拥有多个 [HttpXxx] 属性，以使一种方法接受多个 HTTP 方法。与一些智能的 ModelBinder 配合使用，这是非常强大的。