MVC3 RESTful API路由和HTTP动词处理

Question

MVC3 RESTful API路由和HTTP动词处理

asp.net-mvcasp.net-mvc-3restasp.net-mvc-routing

9

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

我已经阅读/学习/尝试了以下内容：

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

路由约束在MVC启动之前在路由模块中发生，这将导致我有4个明确的路由，并且仍需要单独命名控制器操作。

构建自定义Http动词属性可用于捕获用于访问操作的动词，然后将其作为参数传递给调用操作 - 代码将处理switch案例。此方法的问题是某些方法将需要授权，这应该在操作过滤器级别处理，而不是在操作本身内部处理。 ASP.NET MVC AcceptVerbs and registering routes

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

需求/目标

One route signature for a single instance object, MVC is expected to handle the four main Http Verbs: GET, POST, PUT, DELETE.

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

When the URI is not passed an Id parameter, an action must handle POST and PUT.
```
public JsonResult Index(Item item) { return new JsonResult(); }
```
When an Id parameter is passed to the URI, a single action should handle GET and DELETE.
```
public JsonResult Index(int id) { return new JsonResult(); }
```

问题

如何让多个动作（具有相同名称和方法签名）分别响应不同的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); */ }

- one.beat.consumer

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Lucero · Accepted Answer

对于RESTful调用而言，动作本身并没有意义，因为您只想通过HTTP方法来区分它们。所以诀窍是使用一个静态的动作名称，以便控制器上不同的方法仅在它们接受的HTTP方法上有所不同。

虽然MVC框架提供了指定动作名称的解决方案，但可以使其更简洁和自我解释。我们这样解决：

使用特殊属性来指定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，这非常强大。