You need to enable JavaScript to run this app. ASP.NET Core 3.1 Web API 自定义JSON返回格式问题咨询
优惠活动
大模型
产品
解决方案
定价
更多

ASP.NET Core 3.1 Web API 自定义JSON返回格式问题咨询

实现方案

你可以通过以下两种常用方式实现返回结构的包装:

方法1:定义强类型包装类(推荐,可维护性更高)

  1. 新增一个响应包装类:
public class ProductListResponse
{
    // 如果全局没有配置驼峰命名,可加[JsonPropertyName("product")]特性保证返回键名符合要求
    public List<Product> Product { get; set; }
}
  1. 修改Get接口的Action逻辑,将查询到的Product数组赋值给包装类再返回:
// 原返回逻辑参考
// var products = _dbContext.Products.ToList();
// return Ok(products);

// 修改后的逻辑
var products = _dbContext.Products.ToList();
return Ok(new ProductListResponse { Product = products });

方法2:使用匿名类(无需额外定义类,适合快速实现)

直接在返回时构造匿名对象即可,不用新增单独的响应类:

var products = _dbContext.Products.ToList();
return Ok(new { product = products });

注意事项

如果返回的键名出现大写开头的Product不符合要求,可全局配置JSON序列化规则为驼峰命名:

  • 若使用ASP.NET Core默认的System.Text.Json,在Program.cs中添加配置:
builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.PropertyNamingPolicy = System.Text.Json.JsonNamingPolicy.CamelCase;
    });
  • 若使用Newtonsoft.Json,配置如下:
builder.Services.AddControllers()
    .AddNewtonsoftJson(options =>
    {
        options.SerializerSettings.ContractResolver = new Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver();
    });

1万多条数据的场景下,该外层包装几乎无额外性能开销,无需担心性能问题。


内容的提问来源于stack exchange,提问作者Ali

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.10.20 13:45:03