配置WebAPI2路由以支持不同类型的获取请求(操作/ID)

Question

我希望能够支持这些URL：

// GET:  api/Users              returns a list (all)
// GET:  api/Users/5            returns the user with Id 5
// GET:  api/Users/Active       returns a list (only those not soft-deleted)
// POST: api/Users              creates a user

我首先尝试以这种方式进行配置：

config.Routes.MapHttpRoute(
    name: "DefaultApi",
    routeTemplate: "api/{controller}/{id}",
    defaults: new { id = RouteParameter.Optional }
);

，但是我无法支持api/Users/Active请求

所以我尝试以这种方式进行配置：

config.Routes.MapHttpRoute(
    name: "DefaultApi",
    routeTemplate: "api/{controller}/{action}/{id}",
    defaults: new { id = RouteParameter.Optional }
);

，但是我无法支持api/Users/5请求

是否可以两者支持？

Answer 1

注册多个路由。

您还可以提供约束，这限制了URI段如何匹配占位符：

constraints: new { id = @"d+" }   // Only matches if "id" is one or more digits.

示例

// GET:  api/Users              returns a list (all)
// GET:  api/Users/5            returns the user with Id 5
// POST: api/Users              creates a user
config.Routes.MapHttpRoute(
    name: "Api",
    routeTemplate: "api/{controller}/{id}",
    defaults: new { id = RouteParameter.Optional },
    constraints: new { id = @"d+" }
);
// GET:  api/Users/Active       returns a list (only those not soft-deleted)
config.Routes.MapHttpRoute(
    name: "DefaultApi",
    routeTemplate: "api/{controller}/{action}/{id}",
    defaults: new { id = RouteParameter.Optional }
);

或启用属性路由。

public static class WebApiConfig {
    public static void Register(HttpConfiguration config) {
        // Attribute routing.
        config.MapHttpAttributeRoutes();
        // Convention-based routing.
        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );
    }
}

控制器

[RoutePrefix("api/users")]
public class UsersController : ApiController {
    // GET:  api/Users              returns a list (all)
    [HttpGet]
    [Route("")] 
    public IHttpActionResult Get() { ... }
    // GET:  api/Users/5            returns the user with Id 5
    [HttpGet]
    [Route("{id:int}")] 
    public IHttpActionResult Get(int id) { ... }
    // GET:  api/Users/Active       returns a list (only those not soft-deleted)
    [HttpGet]
    [Route("Active")] 
    public IHttpActionResult Active() { ... }
    // POST: api/Users              creates a user
    [HttpPost]
    [Route("")] 
    public IHttpActionResult Post(User user) { ... }
}