C# API返回JSON时缺失IList<RoutePath>类型Paths子属性如何解决
问题原因
ApiRouteDocument类中的Paths成员是公共字段,而非公共属性,ASP.NET Core 默认的 JSON 序列化器仅序列化公共属性,不会主动序列化公共字段,这是导致子属性丢失的核心原因。
修复方案
方案1(推荐):将公共字段改为公共属性
直接给Paths添加属性访问器即可,修改后的类定义如下:
public class ApiRouteDocument { //controllername tag public string ControllerName { get; set; } public string ControllerDescription { get; set; } // 新增get/set访问器,从字段改为属性 public IList<RoutePath> Paths { get; set; } } public class RoutePath { //get public string Method { get; set; } //operationid public string Name { get; set; } //summary public string Description { get; set; } //path public string Path { get; set; } }
修改完成后重新启动项目即可正常返回Paths节点。
方案2:配置序列化器支持公共字段序列化
如果业务逻辑要求不能修改Paths为属性,可以手动修改JSON序列化配置,允许序列化公共字段:
- 若使用默认
System.Text.Json序列化器(ASP.NET Core 3.0+默认配置):
在Program.cs(.NET 6及以上)或Startup.cs的ConfigureServices方法中添加如下配置:
builder.Services.AddControllers() .AddJsonOptions(options => { // 开启公共字段序列化支持 options.JsonSerializerOptions.IncludeFields = true; // 可选:如果存在循环引用问题添加该配置 options.JsonSerializerOptions.ReferenceHandler = System.Text.Json.Serialization.ReferenceHandler.IgnoreCycles; });
- 若使用
Newtonsoft.Json序列化器:
修改配置如下:
builder.Services.AddControllers() .AddNewtonsoftJson(options => { options.SerializerSettings.ContractResolver = new Newtonsoft.Json.Serialization.DefaultContractResolver { DefaultMembersSearchFlags = System.Reflection.BindingFlags.Instance | System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.Fields | System.Reflection.BindingFlags.Properties }; });
额外检查
修改配置后如果仍然无法返回Paths节点,请确认_apiExplorer.GetndpointDescription()方法中已经给每个ApiRouteDocument对象的Paths成员正确赋值,未赋值的null字段/属性在默认配置下会被序列化器忽略。
内容的提问来源于stack exchange,提问作者Rasik
相关产品推荐
相关产品推荐

