如何扩展 MVC4 中的内容协商行为？

Question

我正在研究一个 RESTful API 设计，我在 Programmers StackExchange 网站here 上发布了关于内容协商的问题之一。

基于此，我对如何在 MVC4 中支持以下行为感兴趣：

1. 如果在 URL 上指定了扩展名（例如，GET /api/search.json 或 /api/search.xml），请覆盖 MVC4 中的默认内容协商行为
2. 如果未指定扩展名，则使用默认行为检查 application/xml 或 application.json 的接受标头值。

捕获此扩展并修改内容协商行为的最简洁/最直接的方法是什么？

Answer 1

您可以使用格式化程序中的 UriPathExtensionMapping 来完成此操作。这些映射使您可以将扩展“分配”到格式化程序，以便在内容协商期间优先考虑它们。您还需要添加一个路由，以便也接受带有“扩展名”的请求。下面的代码显示了启用此方案所需的默认模板中的更改。

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

        routes.MapHttpRoute(
            name: "Api with extension",
            routeTemplate: "api/{controller}.{ext}/{id}",
            defaults: new { id = RouteParameter.Optional, ext = RouteParameter.Optional }
        );

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

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

    protected void Application_Start()
    {
        AreaRegistration.RegisterAllAreas();

        RegisterGlobalFilters(GlobalFilters.Filters);
        RegisterRoutes(RouteTable.Routes);

        GlobalConfiguration.Configuration.Formatters.XmlFormatter.AddUriPathExtensionMapping("xml", "text/xml");
        GlobalConfiguration.Configuration.Formatters.JsonFormatter.AddUriPathExtensionMapping("json", "application/json");
        BundleTable.Bundles.RegisterTemplateBundles();
    }