.NET 8 Minimal API中PageResult<T>无法返回OData格式JSON

1. 完善OData服务注册配置 #

在Program.cs中确保完整配置OData的查询特性，尤其是启用计数和分页支持：

builder.Services.AddControllers()
    .AddOData(options =>
        options.Select().Filter().OrderBy().Expand()
        .Count() // 启用@odata.count支持
        .SetMaxTop(100) // 设置最大分页条数
        .AddRouteComponents("odata", GetEdmModel()));

// 定义EDM模型（需包含实体或DTO的元数据）
static IEdmModel GetEdmModel()
{
    ODataConventionModelBuilder modelBuilder = new();
    modelBuilder.EntitySet<Item>("Items");
    modelBuilder.EntitySet<ItemDto>("ItemDtos"); // 注册DTO的实体集，让OData识别结构
    return modelBuilder.GetEdmModel();
}

2. 端点的正确实现方式 #

Minimal API中不能直接用Results.Ok返回PageResult<T>，需要结合OData的格式化扩展方法，确保返回结果被OData处理器处理：

app.MapGet("/odata/items", async (ODataQueryOptions<Item> queryOptions, IItemService itemService) =>
{
    // 应用OData查询到数据源
    var processedQuery = queryOptions.ApplyTo(itemService.GetItemQueryable()) as IQueryable<Item>;
    
    // 获取总计数（需配合请求中的$count=true参数）
    var totalCount = await processedQuery.CountAsync();
    // 获取当前页数据
    var items = await processedQuery.ToListAsync();
    
    // 转换为DTO
    var itemDtos = items.Select(i => new ItemDto 
    { 
        Id = i.Id, 
        Name = i.Name,
        // 其他字段映射
    }).ToList();
    
    // 构建OData风格的PageResult，自动生成nextLink
    var pageResult = new PageResult<ItemDto>(
        itemDtos,
        queryOptions.Request.GetNextPageLink(totalCount),
        totalCount);
    
    // 使用OData格式化器返回结果，而非普通Results.Ok
    return TypedResults.Ok(pageResult).WithODataFormatting();
})
.EnableODataQueryFeatures(); // 启用端点的OData查询特性支持

3. 关键注意事项 #

• 确保使用的PageResult<T>来自Microsoft.AspNetCore.OData.Query命名空间，而非自定义类。
• 请求时需携带$count=true参数（如/odata/items?$top=10&$skip=0&$count=true），才会返回@odata.count字段。
• 若使用DTO，必须在EDM模型中注册对应的实体集，否则OData无法识别DTO结构生成正确格式。

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