c# - Web API OData V3 `$inlinecount` 失败

Question

我在 ASP.NET Web API 应用程序中使用开箱即用的 ValuesController

 public class ValuesController : ApiController
 {
     // GET api/values
     [Queryable(PageSize = 1)]
     public IQueryable<string> Get()
     {
         return new string[] { "value1", "value2", "value3", "value4", "value5" }.AsQueryable();
     }
 }

当我获取http://localhost/api/values?$inlinecount=allpages

这是回应

<ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<string>value1</string>
</ArrayOfString>

我已取消注释 config.EnableQuerySupport();

过滤、排序工作正常。

如果我尝试 get http://localhost/api/values?$inlinecount=XXXXX 我得到一个异常，所以 Web API 应用程序似乎知道 inlinecount

<Message>The query specified in the URI is not valid.</Message>
<ExceptionMessage>'xxx' is not a valid value for $inlinecount.</ExceptionMessage> 
<ExceptionType>Microsoft.Data.OData.ODataException</ExceptionType>

我肯定有 Microsoft.AspNet.WebApi.OData 包 - 这是包管理器控制台的输出

PM> Install-Package Microsoft.AspNet.WebApi.OData 
Attempting to resolve dependency 'Microsoft.Net.Http (= 2.0.20710.0 && < 2.1)'.
Attempting to resolve dependency 'Microsoft.AspNet.WebApi.Client (= 4.0.20710.0 && < 4.1)'.
Attempting to resolve dependency 'Newtonsoft.Json (= 4.5.6)'.
Attempting to resolve dependency 'Microsoft.AspNet.WebApi.Core (= 4.0.20710.0 && < 4.1)'.
Attempting to resolve dependency 'Microsoft.Data.OData (= 5.2.0 && < 5.3.0)'.
Attempting to resolve dependency 'System.Spatial (= 5.2.0)'.
Attempting to resolve dependency 'Microsoft.Data.Edm (= 5.2.0)'.
'Microsoft.AspNet.WebApi.OData 4.0.0' already installed.
WebServicesProject already has a reference to 'Microsoft.AspNet.WebApi.OData 4.0.0'.

有什么建议吗？

Answer 1

好问题。

开箱即用的 $inlinecount 仅在您发送回 OData 响应时有效。这是因为 OData 在数据中定义了 XML 和 JSON 未定义的特殊字段。因此，在 OData 中，响应可能如下所示:

{
  "odata.metadata":"http://localhost:12345/odata/$metadata#Customers",
  "odata.count":"4",
  "value":[ ... ]
}

请注意具有“odata.count”属性的包装器。这与默认的 XML 和 JSON 格式化程序写出数据的方式不同，因为它们没有用于此附加信息的包装器。所以其他格式化程序默认不变。

现在你有几个选择:

您可以选择使用 OData 格式。为此，您需要按照此博客文章中的说明进行操作:

http://blogs.msdn.com/b/webdev/archive/2013/01/29/getting-started-with-asp-net-webapi-odata-in-3-simple-steps.aspx

您也可以选择返回 PageResult<T> .这看起来像这样:

public PageResult<Customer> Get(ODataQueryOptions<Customer> queryOptions)
{
    IQueryable results = queryOptions.ApplyTo(_customers.AsQueryable());
    return new PageResult<Customer>(results as IEnumerable<Customer>, Request.GetNextPageLink(), Request.GetInlineCount());
}

这应该适用于 OData、JSON 和 XML，方法是为 XML 和 JSON 添加一个包装对象，其中可以包含计数和下一页链接。