c# - 我的 Web API 序列化出现错误

Question

我有一个带有多个返回不同结果的 Controller 的 WebApi。例如，一个 Controller 返回 IEnumerable<Foo> ，另一个Bar ，另一个IEnumerable的IEnumerable等等，我所要做的就是:

return Ok(thething)

一切工作正常，即使是复杂的嵌套对象也可以毫无问题地序列化。

现在，客户要求所有结果都在包装器中返回:

public class Wrapper
{
    public bool Success { get; set; }
    public int ErrorCode { get; set; }
    public String ErrorMessage { get; set; }
    public String Referrer { get; set; }
    public Object Payload { get; set; }
}

认为这很简单，但是当我尝试从 Controller 返回它时:

return Ok(new Wrapper { Success = true, Referrer = "me", Payload = thething)

我收到序列化错误:

The 'ObjectContent`1' type failed to serialize the response body for content type 'application/xml; charset=utf-8'.

内部异常消息是:

'System.Linq.Enumerable+WhereSelectListIterator2[[EPiServer.Find.Api.SearchHit1[[DGTNext.Api.Data.Entities.ProductSummary,DGTNext.Api.Entities, Version=1.0.0.0, Culture=neutral,PublicKeyToken=null]], EPiServer.Find, Version=9.6.0.3185,Culture=neutral,PublicKeyToken=8fe83dea738b45b7],[DGTNext.Api.Data.Entities.ProductSummary,DGTNext.Api.Entities, Version=1.0.0.0, Culture=neutral,PublicKeyToken=null]]' with data contract name'ArrayOfProductSummary:http://schemas.datacontract.org/2004/07/DGTNext.Api.Data.Entities'is not expected. Consider using a DataContractResolver if you areusing DataContractSerializer or add any types not known statically tothe list of known types - for example, by using the KnownTypeAttributeattribute or by adding them to the list of known types passed to theserializer.

我做错了什么？为什么 Ok()函数之前似乎可以处理任何对象，但现在有问题？

谢谢。

编辑:根据要求，导致错误的简单示例:

class Foo 
{
    public int AnInt { get; set; }
}

public IHttpActionResult Get() 
{
    return Ok(new Wrapper { Success = true, Referrer = "me", Payload = new Foo { AnInt = 7 } });
}

编辑#2:好吧，我想出了一种解决方案，但它仍然提出了一些问题。

我使我的包装器在有效负载类型中通用。

public class Wrapper<T>
{
    public bool Success { get; set; }
    public int ErrorCode { get; set; }
    public String ErrorMessage { get; set; }
    public String Referrer { get; set; }
    public T Payload { get; set; }
}

现在，这有效了:

public IHttpActionResult Get() 
{
    List<Foo> foos = new List<Foo>();
    foos.Add(new Foo { AnInt = 7 });
    foos.Add(new Foo { AnInt = 8 });

    return Ok(new Wrapper<IEnumerable<Foo>> { Success = true, Referrer = "me", Payload = foos });
}

它返回:

{
    "Success": true,
    "ErrorCode": 0,
    "ErrorMessage": null,
    "Referrer": "me",
    "Payload": [ { "AnInt": 7 }, { "AnInt": 8 } ] 
}

还有我的“真实”电话:

public IHttpActionResult Get() 
{
    IEnumerable<ProductSummary> prods =  db.getProductSummaries(shopId, culture, queryParams, paging);
    return Ok(new Wrapper<IEnumerable<ProductSummary>> { Success = true, Referrer = "me", Payload = prods });
}

返回:

<WrapperOfArrayOfProductSummaryzc2y5_Pnl>
    <ErrorCode>0</ErrorCode>
    <ErrorMessage i:nil="true"/>
    <Payload>
        <d2p1:ProductSummary>
            <d2p1:Culture i:nil="true"/>
            <d2p1:Guid i:nil="true"/>
            <d2p1:Id>2</d2p1:Id>
            <d2p1:Name>Letto Asia</d2p1:Name>
            <d2p1:ambient>
                <d2p1:Id>1073741838</d2p1:Id>
                <d2p1:Name>notte</d2p1:Name>
            </d2p1:ambient>  
    etc.

所以还不错，但这提出了两个问题:

1. 为了测试 webapi，我通过在 Firefox 地址栏中输入 URL 并在浏览器中查看结果来调用它。为什么第一个调用返回 Json，第二个调用返回 XML？据我所知，我只是使用默认的一切。

2. 为什么 XML 现在要将该命名空间添加到所有元素名称中？我可以阻止这种情况吗？当我只是在没有包装器的情况下返回相同的东西时，这并没有发生。

Answer 1

将此代码添加到 Application_Start 下面的 global.asax 中:

从.忽略更新为.序列化。它必须有效。

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Serialize;
        GlobalConfiguration.Configuration.Formatters.Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter);

或者你可以看看这个answer