UriPathExtensionMapping控制WebAPI中的响应格式

时间:2013-02-06 11:39:37

标签: asp.net-web-api asp.net-web-api-routing

我在使用ASP.NET WebAPI中的UriPathExtensionMapping时遇到问题。我的设置如下:

我的路线是:

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

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

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

我的全球ASAX文件是:

    AreaRegistration.RegisterAllAreas();

    WebApiConfig.Register(GlobalConfiguration.Configuration);
    FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
    RouteConfig.RegisterRoutes(RouteTable.Routes);
    BundleConfig.RegisterBundles(BundleTable.Bundles);

我的控制器是:

public IEnumerable<string> Get()
{
    return new string[] { "Box", "Rectangle" };
}

// GET /api/values/5
public string Get(int id)
{
    return "Box";
}

// POST /api/values
public void Post(string value)
{
}

// PUT /api/values/5
public void Put(int id, string value)
{
}

// DELETE /api/values/5
public void Delete(int id)
{
}

使用curl发出请求时,JSON是默认响应,即使我明确请求XML我仍然得到JSON:

curl http://localhost/eco/api/products/5.xml

返回:

"http://www.google.com"

有人能看到我的设置问题吗?

以下代码在配置路由后映射Global.asax文件中的扩展名:

    GlobalConfiguration.Configuration.Formatters.JsonFormatter.
        MediaTypeMappings.Add(
            new UriPathExtensionMapping(
                "json", "application/json"
        )
    );

    GlobalConfiguration.Configuration.Formatters.XmlFormatter.
        MediaTypeMappings.Add(
            new UriPathExtensionMapping(
                "xml", "application/xml"
        )
    );

2 个答案:

答案 0 :(得分:5)

您是否需要注册扩展名映射:

config.Formatters.JsonFormatter.MediaTypeMappings.Add(new UriPathExtensionMapping("json", "application/json"));
config.Formatters.XmlFormatter.MediaTypeMappings.Add(new UriPathExtensionMapping("xml", "application/xml"));

找到示例here

<强>更新

如果查看UriPathExtensionMapping的代码,则扩展名的占位符为

/// <summary>
/// The <see cref="T:System.Uri"/> path extension key.
/// </summary>
public static readonly string UriPathExtensionKey = "ext";

因此,您的路线需要更改为({ext}而不是{extension}):

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

答案 1 :(得分:1)

作为此答案的补充,因为我还无法发表评论,您还应该确保您的web.config包含该行

<modules runAllManagedModulesForAllRequests="true" />

<system.webServer>部分内。

我没有,这个例子对我来说没有用,直到我添加该行。