使用ODataQueryOptions调用Web API遇自引用循环错误求助

这个错误是因为ODataQueryOptions对象内部的Edm模型结构存在循环引用，当Web API尝试序列化相关对象（比如返回错误详情时），JSON序列化器无法处理这种循环依赖，就抛出了Self referencing loop异常。结合你的代码和请求情况，给你几个针对性的解决方案：

1. 修正请求URL格式 #

你当前的请求URL写法有问题：

https://localhost:44360/api/get/ $select...

正确的OData查询参数应该作为URL的查询部分，不要在api/get后加斜杠，且参数前无空格，示例格式如下：

https://localhost:44360/api/get?$select=YourDummyProperty1,YourDummyProperty2

错误的URL格式可能触发模型绑定异常，进而导致框架尝试序列化ODataQueryOptions对象，暴露循环引用问题。

2. 配置JSON序列化器忽略循环引用 #

根据你使用的Web API类型，通过配置序列化器跳过循环引用的处理：

对于ASP.NET Web API（基于Newtonsoft.Json） #

在WebApiConfig.cs的Register方法中添加配置：

public static void Register(HttpConfiguration config)
{
    // 保留原有其他配置...
    config.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
}

对于ASP.NET Core（基于System.Text.Json） #

在Program.cs或Startup.cs中配置：

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.ReferenceHandler = ReferenceHandler.IgnoreCycles;
    });

3. 确保OData模型配置正确 #

如果你的Dummy类包含复杂关联关系（比如自引用属性），可能导致Edm模型生成时出现循环结构。可以检查Dummy类定义，或显式配置OData模型避免不必要的循环引用：

public static IEdmModel GetEdmModel()
{
    ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
    builder.EntitySet<Dummy>("Dummies");
    // 可手动配置属性，排除可能引发循环的引用项
    return builder.GetEdmModel();
}

然后在Web API配置中注册该模型：

config.MapODataServiceRoute("ODataRoute", null, GetEdmModel());

补充说明 #

你的API方法目前返回null，正常情况不会触发序列化，但如果请求格式错误导致模型绑定失败，框架会尝试返回包含错误详情的响应，其中可能涉及ODataQueryOptions的内部结构，这就是触发错误的原因。上面的配置可以从根本上解决序列化时的循环引用问题。

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