.NET Core 3.1派生类重写父类属性时JSON特性不生效求助

DevOps 小满

2026-8-23

解决.NET Core 3.1中Newtonsoft.Json子类重写属性Swagger显示异常问题

问题场景

使用.NET Core 3.1搭配Newtonsoft JSON.NET时，子类重写父类的virtual属性后出现以下异常：

子类添加[JsonIgnore]，Swagger仍显示父类的tags属性
子类添加[JsonProperty(PropertyName = "test123")]，Swagger同时显示原tags和新属性名test123

核心原因

Swashbuckle.AspNetCore默认使用System.Text.Json生成API Schema，而项目实际用Newtonsoft.Json处理序列化，两者规则不兼容，导致子类重写属性上的Newtonsoft特性未被Swagger正确识别。

解决方案

1. 安装适配的Swashbuckle Newtonsoft包

安装对应.NET Core 3.1的Swashbuckle.AspNetCore.Newtonsoft版本（5.x系列，如5.6.3）：

Install-Package Swashbuckle.AspNetCore.Newtonsoft -Version 5.6.3

2. 配置Swagger使用Newtonsoft契约解析

在Startup.cs的ConfigureServices方法中，给Swagger添加Newtonsoft支持：

services.AddControllers()
        .AddNewtonsoftJson(options =>
        {
            options.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;
        });

// 配置Swagger并启用Newtonsoft支持
services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "你的API名称", Version = "v1" });
})
.AddSwaggerGenNewtonsoftSupport(); // 关键配置：让Swagger使用Newtonsoft的规则生成Schema