如何在.NET Core5 WebAPI同一控制器的第二个端点强制输出odata格式

方案1：调整EDM配置适配同控制器多端点（无需新增控制器） #

你之前的EDM只绑定了控制器对应的默认实体集，第二个端点无法被OData路由识别为合规OData端点，自然不会自动加包装。按以下步骤调整即可：

1. 给第二个端点加明确的路由别名和OData路由注解：

[HttpGet("CustomList")]
[EnableQuery]
[ODataRoute(nameof(CustomList))] // 显式标注为OData路由
public IQueryable<MyModel> CustomList()
{
    return _DbContext.MyModels.Where(x => x.IsActive); // 替换为你的自定义业务逻辑
}

2. 在EDM构造方法中注册这个自定义操作：

private static IEdmModel GetEdmModel()
{ 
    var builder = new ODataConventionModelBuilder();
    var entitySet = builder.EntitySet<MyModel>("NameOfMycontrollers");
    // 注册自定义端点到对应实体集
    entitySet.EntityType.Collection
        .Function(nameof(CustomList))
        .ReturnsCollectionViaEntitySetPath<MyModel>("NameOfMycontrollers");
    return builder.GetEdmModel();
}

3. 确保Startup.cs中OData路由配置开启了属性路由：

services.AddControllers()
    .AddOData(opt => 
        opt.Select().Filter().Count().OrderBy().Expand()
           .SetMaxTop(100)
           .AddRouteComponents("odata", GetEdmModel())
           .EnableAttributeRouting = true // 必须开启属性路由才能识别自定义OData端点
    );

配置完成后第二个端点会和默认端点一样自动带上@odata.context、count、nextLink等装饰，完整支持所有OData查询语法。

方案2：完全抛弃ODataConventionModelBuilder，手动构造OData包装响应 #

如果不想维护EDM配置，可以直接在端点中手动构造符合OData规范的返回结果，同时保留查询能力：

[HttpGet("CustomListNoEdm")]
public IActionResult CustomListNoEdm(ODataQueryOptions<MyModel> options)
{
    // 手动应用OData查询逻辑
    var query = options.ApplyTo(_DbContext.MyModels.AsNoTracking()) as IQueryable<MyModel>;
    // 统计总条数（对应$count参数需求）
    long? totalCount = null;
    if (options.Count != null && options.Count.Value)
    {
        totalCount = _DbContext.MyModels.LongCount();
    }
    // 手动构造OData格式响应体
    var result = new
    {
        @odata.context = $"{Request.Scheme}://{Request.Host}/odata/$metadata#NameOfMycontrollers",
        @odata.count = totalCount,
        // 生成分页nextLink（如果有$top参数且还有未返回的后续数据）
        @odata.nextLink = options.Skip != null && options.Top != null && query.Count() == options.Top.Value 
            ? $"{Request.Path}?$skip={options.Skip.Value + options.Top.Value}&{Request.QueryString.ToString().TrimStart('?')}" 
            : null,
        value = query.ToList()
    };
    return Ok(result);
}

这种方式完全不需要配置EDM，你可以灵活控制返回的装饰字段，所有OData查询语法也可以正常生效。

注意事项 #

• .NET 5需要搭配Microsoft.AspNetCore.OData 8.x及以上版本使用，该版本才原生支持同控制器多OData端点配置。
• 如果端点返回类型为IQueryable，不要提前执行ToList()等操作，否则OData查询会在内存执行，大幅影响接口性能。

内容的提问来源于stack exchange，提问作者Simon