Web API 返回 JSON 内容类型而不是 XML

Question

我是全新接触Web API的。 我正在为我的团队开展概念验证项目，我们将基于Web-API XML数据源创建SSRS 2012报表。 然而，Web-API 不应仅配置为协商 XML 内容类型。 在未来阶段，我们的 Web 应用程序应该能够从同一控制器/操作检索 json 对象。 我开始按照 此教程 进行，并且一切都很好，没有问题。 接下来，我配置了我的路由，以便可以直接调用操作，并向 Global.asax 添加了 QueryStringMappings，以便我可以指定内容类型。

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

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

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

public class WebApiApplication : System.Web.HttpApplication
{
    protected void Application_Start()
    {
        AreaRegistration.RegisterAllAreas();

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

        GlobalConfiguration.Configuration.Formatters.JsonFormatter.AddQueryStringMapping("$format", "json", "application/json");
        GlobalConfiguration.Configuration.Formatters.XmlFormatter.AddQueryStringMapping("$format", "xml", "application/xml");
    }
}

这很有效，我现在可以使用 localhost:XXXXX/api/Products/GetAllProducts/?$format=xml 作为我的数据源连接字符串在 SSRS 中。我不确定这是否是最佳方法，但它起作用了，所以我坚持使用它。如果没有查询字符串映射，数据源就无法在 SSRS 中工作。 这里是我遇到麻烦的地方。我分支出去创建了我的第一个模型/控制器/操作。当我在浏览器中运行项目（chrome 或 IE 10）并尝试将格式指定为 XML（localhost:XXXXX/api/Calcs/ComputeFooCalculation?$format=xml），我得到了一个 json 结果。 Products 控制器继续对 json 或 xml 内容类型正常工作。但由于某种原因，我的操作只能呈现为 json。这是我的代码样子。如果您需要模型或其他任何东西，请告诉我。FooCalculation 具有嵌套对象 Bar。FooCalculation 和 Bar 都有字符串、双精度和 DateTime。 控制器:

public class CalcsController : ApiController
{

    public FooCalculation ComputeFooCalculation()
    {
        var Foo = GetFoo();
        var Bar = GetBar();
        var FooCalculation = new FooCalculation(Foo, Bar);

        return FooCalculation;
    }

}

样本JSON结果：

{"Foo":"XXX","FooRate":{"Foo":"XXX","Bar":"SN","FooBar":-1.00813E-05,"BarFoo":-3.2644199999999995E-06,"FoooBarrr":-4.17501E-06,"BarDate":"2013-05-14T00:00:00"},"BarRate":{"Foo":"XXX","Bar":"1W","FooBar":-2.08687E-05,"BarFoo":-3.11313E-05,"FoooBarrr":-3.3E-05,"BarDate":"2013-05-21T00:00:00"},"BarDate":"2013-05-20T00:00:00","FooDays":6,"FooBar":-7.3741306716417904E-06,"Bar":-0.0011149741306716415}

感谢您提前的帮助。

- Ryan

Answer 1

在您的模型类中放置一个无参数的构造函数。XML格式化程序试图在检索所有数据之前实例化一个空的XML树。

- btm86042

---

谢谢，那个方法可行！另一种解决这个问题的方法是使用DataContract属性（System.Runtime.Serialization）。这允许您指定XML树。 - Ryan

我不知道为什么这个回答被接受了，因为它对我没有用。正确的方法是将以下行添加到WebApiRegister.Register中：config.Formatters.Remove(config.Formatters.XmlFormatter); - newman

这种情况通常在存在一些XML验证问题时出现，例如缺少无参构造函数、某些xml属性定义两次或不可序列化的子类型等。首先尝试使用一些单元测试或类似工具检查您的类/层次结构是否可序列化。然后再看其他地方。 - Eleasar