使用 OData 在 .NET API 上返回嵌套对象

Question

我正在开发一个使用 OData 的 .NET API，我目前在将嵌套对象返回给客户端时遇到问题。

一切似乎都在工作，即使我在响应之前在控制器上设置了一个断点。我可以看到将要返回的所有信息都正确填充的 Vendor 对象，但是当我查看客户端收到的 JSON 响应时，它只有原始类型和枚举，其他所有作为另一个对象的属性都不会被序列化到 JSON 结果。

public class Vendor : IEntity
{
    public virtual int Id { get; set; }
    public virtual VendorAddress PrimaryAddress { get; set; }
    public virtual string VendorName { get; set; }
}

public class VendorAddress : IEntity
{
    public virtual int Id { get; set; }
    public virtual Vendor Vendor { get; set; }
    public virtual Address Address { get; set; }

}

 public class Address : IEntity
{
    public virtual int Id { get; set; }   
    public virtual string Line1 { get; set; }
    public virtual string Line2 { get; set; }     
    public virtual string Country { get; set; }
    public virtual string CountryCode { get; set; }
    public virtual string City { get; set; }
    public virtual string County { get; set; }
    public virtual string StateProvince { get; set; }
    public virtual string ZipCode { get; set; }    
}   

 public SingleResult<Vendor> Get([FromODataUri] int key)
{
    var result = _repository.Query<Vendor>().Where(a => a.Id == key);
    return SingleResult.Create(result);
}

基本上我想返回供应商信息，包括 JSON 结果中的 PrimaryAddress/Address 信息，但似乎无法弄清楚如何。

Answer 1

VendorAddress 和Address 是所谓的导航属性。 您可以在查询中使用$expand 来获取它们。 首先将 [EnableQuery] 添加到您的 Get 方法中

[EnableQuery]
public SingleResult<Vendor> Get([FromODataUri] int key)

然后尝试表单中的请求

<serviceUri>/Vendor(1)?$expand=VendorAddress
<serviceUri>/Vendor(1)?$expand=VendorAddress($expand=Address)

你必须添加行

config.Expand()

在你的

WebApiConfig.Register(HTTPConfiguration config)

方法。

这是一个测试服务的示例请求：

http://services.odata.org/TripPinRESTierService/People('russellwhyte')?$expand=BestFriend($expand=Trips)

还有更多信息供参考：http://www.odata.org/odata-services/

希望这会有所帮助。