ASP.NET WEB API 深入理解:属性路由全面解析

0 下载量 34 浏览量 更新于2024-08-29 收藏 137KB PDF 举报
ASP.NET Web API 的属性路由是一种高级路由机制,允许开发者在控制器方法上直接定义路由模式,以便更灵活地构建API的URL结构。这种路由方式与传统的约定路由(如`api/{controller}/{id}`)相结合,可以提供更加定制化的URL设计。 在常规的ASP.NET Web API中,我们通常使用`MapHttpRoute`方法来配置路由规则。然而,当需要创建如`order/Miles/三只松鼠干果/2袋`或`order/2017/1/13`这样具有特定模式的URL时,通过属性路由可以更方便地实现。要启用属性路由,需要在`WebApiConfig.cs`文件中添加`config.MapHttpAttributeRoutes();`这行代码。 属性路由的使用包括在控制器方法上添加`[Route]`特性。例如: ```csharp [Route("order/{UserNickName}/{ProductName}/{count}")] public IHttpActionResult PlaceOrder(string UserNickName, string ProductName, int count) ``` 这样,Web API会根据`[Route]`特性中的模板匹配请求URL。如果多个路由定义在同一控制器中,它们通常会共享相同的前缀。为了避免重复,可以使用`[RoutePrefix]`来设定公共前缀: ```csharp [RoutePrefix("api/books")] public class BooksController : ApiController { [Route("")] public IHttpActionResult GetBooks() { ... } [Route("{id:int}")] public IHttpActionResult GetBook(int id) { ... } } ``` 对于特殊情况,可以使用`[Route]`特性的波浪线`~`来重写`[RoutePrefix]`,如在一个控制器中部分方法需要不同的前缀。 此外,属性路由支持在参数中添加约束,例如限制参数必须是数字: ```csharp [Route("api/customers/{id:int}")] public IHttpActionResult GetCustomer(int id) { ... } ``` 在上述例子中,`{id:int}`表示`id`参数必须是整数,否则会导致400 Bad Request错误。 ASP.NET Web API的属性路由提供了更高的灵活性,使得开发者能够更好地控制API的URL结构,同时结合传统的约定路由,可以构建出符合业务需求的、易于理解和使用的API接口。