ASP.NET Web API 之 WebApiConfig

WebApiConfig位于WebAPI项目顶层目录App_Start下，并声明了它的WebApiConfig类。WebApiConfig只包含一个Register方法，由global.asax中的Application_Start()方法调用代码。

正如WebApiConfig类的名字表明的，这个类可用于注册Web API配置的各个方面。默认情况下，项目模板生成的主要配置代码会注册一个默认的Web API路由。这个路由将收到的HTTP请求映射到控制器类，并解析YRL中可能带有的数据元素，确保处理管道中的其他类能够使用这些数据。默认的WebApiConfig类如下述代码所示。

    public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // Web API 配置和服务
            // 将 Web API 配置为仅使用不记名令牌身份验证。
            config.SuppressDefaultHostAuthentication();
            config.Filters.Add(new HostAuthenticationFilter(OAuthDefaults.AuthenticationType));


            // Web API 路由
            config.MapHttpAttributeRoutes();


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

你如果精通MVC开发，那么，可能已注意到ASP.NET Web API提供了一套用于注册Web API路由的扩展方法，与默认的MVC路由不同。例如，这个新项目在WebApiConfig类之外，还包含下面的类：

    public class RouteConfig
    {
        public static void RegisterRoutes(RouteCollection routes)
        {
            routes.IgnoreRoute("{resource}.axd/{*pathInfo}");


            routes.MapRoute(
                name: "Default",
                url: "{controller}/{action}/{id}",
                defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
            );
        }
    }

一个项目由两个路由注册方法这一点，乍看之下有些让人不知所以，因此，有必要解释一下二者的大致区别。有一点要记住的是，这些“映射”方法只是扩展方法，创建一个路由实例，并把这个实例添加到与宿主相关的路由集合之中。ASP.NET MVC和ASP.NET Web API的区别及其原因，在于它们使用的路由类不同，甚至路由集合的类型也不相同。ASP.NET Web API之所以使用与ASP.NET MVC不同的路由类型，是为了能够尽量脱离System.Web程序集里的Route和RouteCollection类相关的遗留代码，从而提供更为灵活的托管选项。这种设计带来的直接好处就是，ASP.NET Web API的自托管能力。

配置ASP.NET Web API路由，需要声明HttpRoute实例并添加到路由集合中。虽然创建HttpRoute实例的扩展方法和ASP.NET MVC中的不同，但是，两种方法的语义几乎一样，都使用相同的元素，如路由名、路由模板和默认参数，甚至都使用路由约束。正如实例代码中看到的，项目模板的路由配置代码设置了一个默认的API路由，路由的URL前缀为“api”，后面接控制器名和一个可选的ID参数。这个路由配置不需要进行任何修改，就足以用来创建提供获取、更新和删除数据功能的API。

参考文献

[美] 布洛克（Glenn Block），西布拉奥（Pablo Cibraro） 等 著；金迎 译 《ASP.NET Web API 设计》