MVC C# API：返回含列表属性的RootObject而非直接返回列表

没问题，我来帮你搞定这个需求！要返回包含Album列表的RootObject其实很简单，分两步就能完成：

1. 创建RootObject类 #

首先定义一个顶层的RootObject类，用来包裹你的Album列表——你还可以按需添加一些元数据属性（比如总数量、状态信息），让返回的JSON结构更规范：

public class RootObject
{
    // 核心：存放Album列表的属性
    public List<Album> Albums { get; set; }
    
    // 可选：添加元数据，比如返回的专辑总数
    public int TotalAlbums { get; set; }
    
    // 还可以加其他属性，比如状态码、提示消息等
    // public string Status { get; set; }
}

2. 修改API控制器的Action方法 #

接下来把原来直接返回List<Album>的控制器方法，改成返回RootObject实例就行：

假设你原来的控制器方法是这样的：

public IEnumerable<Album> GetAlbums()
{
    // 从数据库获取专辑列表（这里用EF举例，你实际的数据源可能不同）
    var albumList = db.Albums.ToList();
    return albumList;
}

修改后变成：

public IHttpActionResult GetAlbums()
{
    var albumList = db.Albums.ToList();
    
    // 实例化RootObject并赋值
    var rootResponse = new RootObject
    {
        Albums = albumList,
        TotalAlbums = albumList.Count // 可选的元数据
    };
    
    // 返回带200状态码的JSON响应
    return Ok(rootResponse);
}

最终效果 #

这样你的API返回的JSON结构就会变成带顶层对象的格式，大概是这样：

{
  "albums": [
    {
      "id": 1,
      "albumName": "示例专辑1",
      "yearReleased": 2020,
      "albumInfo": "这是第一张示例专辑",
      "imgAlbumCover": "/covers/album1.jpg"
    },
    {
      "id": 2,
      "albumName": "示例专辑2",
      "yearReleased": 2021,
      "albumInfo": "这是第二张示例专辑",
      "imgAlbumCover": "/covers/album2.jpg"
    }
  ],
  "totalAlbums": 2
}

因为你已经在WebApiConfig.cs里配置过JSON序列化，所以属性名会自动按照你设置的规则（比如camelCase）转换，完全符合前端的常见需求。

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