ASP.NET Core中带额外参数的OData端点无法调用如何解决？

方案一：使用OData自定义函数（符合OData规范） #

1. 配置OData Edm模型 #

在Program.cs中构建Edm模型时，注册你的自定义集合函数，让OData识别该路由：

var builder = WebApplication.CreateBuilder(args);

// 添加OData服务并启用查询选项
builder.Services.AddControllers().AddOData(options =>
{
    options.Select().Filter().OrderBy().Count().SkipToken();
    // 绑定路由前缀与Edm模型
    options.AddRouteComponents("TestServer", BuildEdmModel());
});

var app = builder.Build();

// 中间件配置
app.UseRouting();
app.MapControllers();
app.Run();

// 构建Edm模型的工具方法
static IEdmModel BuildEdmModel()
{
    var modelBuilder = new ODataConventionModelBuilder();
    // 注册实体集
    modelBuilder.EntitySet<DocumentRequestDTO>("RequestDto");
    
    // 注册自定义集合函数GetRequests
    modelBuilder.EntityType<DocumentRequestDTO>().Collection
        .Function("GetRequests")
        .Parameter<string>("userID")
        .Parameter<bool>("showByAuthor")
        .ReturnsCollectionFromEntitySet<DocumentRequestDTO>("RequestDto");
    
    return modelBuilder.GetEdmModel();
}

2. 调整控制器方法 #

使用[ODataRoute]属性（ASP.NET Core OData 8.x及以上版本支持）指定匹配路由，参数用[FromODataUri]绑定：

public class RequestDtoController : ODataController
{
    private readonly YourDbContext _dbContext;

    public RequestDtoController(YourDbContext dbContext)
    {
        _dbContext = dbContext;
    }

    [EnableQuery]
    [ODataRoute("GetRequests(userID={userID}, showByAuthor={showByAuthor})")]
    public IQueryable<DocumentRequestDTO> GetRequests([FromODataUri] string userID, [FromODataUri] bool showByAuthor)
    {
        // 业务逻辑：根据参数过滤数据
        var query = _dbContext.DocumentRequestDTOs.AsQueryable();
        
        if (!string.IsNullOrEmpty(userID))
        {
            query = showByAuthor 
                ? query.Where(r => r.AuthorId == userID) 
                : query.Where(r => r.RequesterId == userID);
        }
        
        return query;
    }
}

3. 正确调用URL #

确保URL格式规范，布尔值使用小写false，无多余换行：

https://localhost:12345/TestServer/RequestDto/GetRequests(userID='0388',showByAuthor=false)?$count=true&$orderby=TimeStamp%20desc&$skip=0&$top=26

方案二：直接使用查询字符串参数（更简洁） #

如果不需要严格遵循OData函数语义，可直接将参数作为查询字符串传递，无需配置自定义函数：

1. 简化控制器方法 #

public class RequestDtoController : ODataController
{
    private readonly YourDbContext _dbContext;

    public RequestDtoController(YourDbContext dbContext)
    {
        _dbContext = dbContext;
    }

    [EnableQuery]
    [HttpGet]
    public IQueryable<DocumentRequestDTO> GetRequests([FromQuery] string userID, [FromQuery] bool showByAuthor)
    {
        // 业务逻辑：根据参数过滤数据
        var query = _dbContext.DocumentRequestDTOs.AsQueryable();
        
        if (!string.IsNullOrEmpty(userID))
        {
            query = showByAuthor 
                ? query.Where(r => r.AuthorId == userID) 
                : query.Where(r => r.RequesterId == userID);
        }
        
        return query;
    }
}

2. 调用URL #

参数直接附加在查询字符串中：

https://localhost:12345/TestServer/RequestDto?$count=true&$orderby=TimeStamp%20desc&$skip=0&$top=26&userID=0388&showByAuthor=false

常见问题排查 #

• 路由匹配失败：方案一中需确保Edm模型正确注册自定义函数；方案二中避免[HttpGet]指定冲突的路由模板。
• 参数绑定失败：检查参数名大小写与URL完全一致，布尔值必须用小写true/false，方案二中字符串参数无需加单引号。
• 版本兼容问题：ASP.NET Core OData 8.x及以上版本支持[ODataRoute]，若使用旧版本建议升级至最新稳定版。

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