首页 > 解决方案 > 使用 AspNetCore.OData 进行分页 - 响应中缺少 @odata 属性

问题描述

我正在尝试使用 asp.net core 2.2 和 Microsoft.AspNetCore.OData 7.1.0 实现分页,配置如下:

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddOData();
        services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
    }

    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        app.UseMvc(b =>
        {
            b.EnableDependencyInjection();
        });
    }
}

为此,我有一个测试控制器:

[Route("api/[controller]")]
[ApiController]
public class ValuesController : ControllerBase
{
    [HttpGet]
    [EnableQuery(PageSize = 5)]
    public IQueryable<int> Get()
    {
        return new int[] { 1,2,3,4,5,6,7,8,9,10 }.AsQueryable();
    }
}

调用端点时,我希望得到如下响应:

{  
  "@odata.context":...,
  "value":[1,2,3,4,5],
  "@odata.nextLink":...  
}

但相反,我只得到:

[1,2,3,4,5]

那么如何获得那些额外的@odata 属性呢?

标签: c#asp.net-corepaginationodataasp.net-core-2.0

解决方案


最后我想出了如何去做。

首先,它不适用于原始类型,因此我必须使用 Id 属性创建强大的类型:

public class Value
{
    public Value(int id)
    {
        Id = id;
    }

    public int Id { get; set; }
}

其次,我必须从控制器中删除ApiControllerRoute属性。

public class ValuesController : ControllerBase
{
    [HttpGet]
    [EnableQuery(PageSize = 5)]
    public IQueryable<Value> Get()
    {
        return Enumerable.Range(1, 10).Select(i => new Value(i)).AsQueryable();
    }
}

最后注册 odata 端点:

ODataModelBuilder builder = new ODataConventionModelBuilder();
builder.EntitySet<Value>("Values");
app.UseOData("odata", "api", builder.GetEdmModel());

推荐阅读