如何将ODataQueryOptions转换为字符串以拼接API请求URL

直接使用内置方法（ASP.NET Core OData 8.x+） #

新版ASP.NET Core OData中，ODataQueryOptions自带ToUriString()方法，可直接生成标准OData查询参数字符串。修改你的代码如下：

public async Task<PageModel<AnalyticsModel>> Get(ODataQueryOptions<CheckListData> options)
{
    using var client = _httpClientFactory.CreateClient(HttpClientEnum.SpotApi);
    // 生成OData查询参数字符串
    var oDataQueryString = options.ToUriString();
    
    // 用UriBuilder安全拼接URL，自动处理?和&的格式问题
    var targetUrl = new UriBuilder(CheckListEndpoints.Get)
    {
        Query = oDataQueryString
    }.ToString();
    
    var response = await client.GetAsync(targetUrl);
    response.EnsureSuccessStatusCode(); // 建议添加错误处理，避免无效响应被反序列化
    var responseString = await response.Content.ReadAsStringAsync();
    
    return JsonSerializer.Deserialize<PageModel<AnalyticsModel>>(responseString);
}

手动构建查询字符串（兼容旧版OData） #

如果使用旧版Web API OData，没有ToUriString()方法，可以手动遍历ODataQueryOptions属性拼接查询字符串：

private string GenerateStringFromOptions(ODataQueryOptions<CheckListData> options)
{
    var queryParts = new List<string>();

    if (options.Filter != null)
        queryParts.Add($"$filter={Uri.EscapeDataString(options.Filter.RawValue)}");
    if (options.OrderBy != null)
        queryParts.Add($"$orderby={Uri.EscapeDataString(options.OrderBy.RawValue)}");
    if (options.Skip != null)
        queryParts.Add($"$skip={options.Skip.RawValue}");
    if (options.Top != null)
        queryParts.Add($"$top={options.Top.RawValue}");
    if (options.Select != null)
        queryParts.Add($"$select={Uri.EscapeDataString(options.Select.RawValue)}");
    // 根据需求添加其他OData参数（如$expand、$count等）

    return string.Join("&", queryParts);
}

调用时替换为：

var oDataQueryString = GenerateStringFromOptions(options);

注意事项 #

• 使用UriBuilder拼接URL可避免手动拼接时出现的重复?或&问题，确保URL格式合法。
• 对OData参数的原始值进行Uri.EscapeDataString编码，防止特殊字符（如空格、引号）导致URL失效。
• 添加response.EnsureSuccessStatusCode()检查，能及时捕获HTTP请求错误。

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