如何在ASP.NET Core极简Web API中返回带嵌套结构的JObject

你的问题确实是因为ASP.NET Core默认使用System.Text.Json作为序列化库，而JObject属于Newtonsoft.Json的类型，两者原生不兼容导致嵌套数据丢失。下面是两种全局层面的解决方案：

方案一：全局切换为Newtonsoft.Json（最直接兼容） #

这是最省心的方案，适合项目中大量使用Newtonsoft.Json类型的场景：

1. 安装NuGet包：

   Install-Package Microsoft.AspNetCore.Mvc.NewtonsoftJson
   

   或使用.NET CLI：

   dotnet add package Microsoft.AspNetCore.Mvc.NewtonsoftJson
   

2. 在Program.cs中配置服务，替换默认序列化器：

   builder.Services.AddControllers()
       .AddNewtonsoftJson(options =>
       {
           // 可按需添加Newtonsoft的自定义配置，比如处理循环引用、日期格式等
           options.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;
       });
   

   配置完成后，所有API端点直接返回JObject即可自动保留完整嵌套结构，无需再手动转字符串。

方案二：给System.Text.Json添加JObject支持（保留默认序列化器） #

如果不想替换默认的System.Text.Json，可以通过自定义转换器让它正确处理JObject：

1. 创建JObject的Json转换器类：

   using System.Text.Json;
   using System.Text.Json.Serialization;
   using Newtonsoft.Json.Linq;
   
   public class JObjectJsonConverter : JsonConverter<JObject>
   {
       public override JObject Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
       {
           using var doc = JsonDocument.ParseValue(ref reader);
           return JObject.Parse(doc.RootElement.GetRawText());
       }
   
       public override void Write(Utf8JsonWriter writer, JObject value, JsonSerializerOptions options)
       {
           writer.WriteRawValue(value.ToString(Newtonsoft.Json.Formatting.None));
       }
   }
   

2. 在Program.cs中注册这个转换器：

   builder.Services.ConfigureHttpJsonOptions(options =>
   {
       options.SerializerOptions.Converters.Add(new JObjectJsonConverter());
   });
   

   这样System.Text.Json就能正确序列化/反序列化JObject，完整保留所有嵌套键值对。

为什么之前配置HttpJsonOptions没用？ #

默认的System.Text.Json没有内置JObject的处理逻辑，必须手动添加自定义转换器才能识别并正确处理这个类型，单纯配置默认选项无法解决问题。

方案选择建议 #

• 如果项目中已经广泛使用Newtonsoft.Json的各类类型（JObject、JArray、JToken等），优先选方案一，兼容性最好，无需额外代码。
• 如果想保持System.Text.Json的性能优势，只是偶尔需要处理JObject，选方案二更合适。

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