.NET 6 WebApi控制器如何返回JSON字符串为子对象？

在.NET 6 WebApi控制器中，我希望返回如下DataModel结构的数据：

public class DataModel
{
    public string Id { get; private set; }

    public string Name { get; private set; }

    public string Description { get; private set; }

    public string ProjectId { get; private set; }

    public string Content { get; private set; }

    public DateTime CreationTime { get; private set; }

    public DateTime? LastModificationTime { get; private set; }
}

当前Swagger返回结果里，Content是JSON字符串格式：

{
  "id": "642af19d6d5bb761f5a62cc0",
  "name": "Test submission 8",
  "description": "test description",
  "projectId": "1a1b1c",
  "content": "{ \"Name\" : \"Test 1\", \"Id\" : \"id1\", \"Value\" : 1 }",
  "creationTime": "2023-04-03T15:32:45Z",
  "lastModificationTime": null
}

我期望Content以JSON子对象形式返回：

{
  "id": "642af19d6d5bb761f5a62cc0",
  "name": "Test submission 8",
  "description": "test description",
  "projectId": "1a1b1c",
  "content": {
    "Name": "Test 1",
    "Id": "id1",
    "Value": 1
  },
  "creationTime": "2023-04-03T15:32:45Z",
  "lastModificationTime": null
}

由于Content的JSON结构不固定，无法创建特定类进行反序列化，请问如何修改Content的类型和对象，使其在控制器返回的JSON中呈现为子对象？

根据需求，有三种可行的实现方式，可根据实际场景选择：

方法1：使用JsonElement类型（推荐） #

JsonElement是System.Text.Json中的原生类型，能精准保留原始JSON的结构和类型信息，完美适配不确定结构的JSON内容场景。

修改DataModel： #

将Content的类型从string改为JsonElement，并在赋值环节将JSON字符串解析为JsonElement：

using System.Text.Json;

public class DataModel
{
    public string Id { get; private set; }
    public string Name { get; private set; }
    public string Description { get; private set; }
    public string ProjectId { get; private set; }
    public JsonElement Content { get; private set; } // 替换为JsonElement类型
    public DateTime CreationTime { get; private set; }
    public DateTime? LastModificationTime { get; private set; }

    // 根据实际业务逻辑调整构造函数或赋值逻辑
    public DataModel(string id, string name, string description, string projectId, string contentJson, DateTime creationTime, DateTime? lastModificationTime)
    {
        Id = id;
        Name = name;
        Description = description;
        ProjectId = projectId;
        // 将JSON字符串解析为JsonElement
        Content = JsonSerializer.Deserialize<JsonElement>(contentJson);
        CreationTime = creationTime;
        LastModificationTime = lastModificationTime;
    }
}

控制器返回DataModel时，Content会直接序列化为JSON子对象，无需额外处理。

方法2：使用object或dynamic类型 #

如果不需要严格保留JSON原始类型（比如数字、布尔的类型转换不影响业务），可以将Content改为object类型，解析时直接反序列化为object：

using System.Text.Json;

public class DataModel
{
    // 其他属性保持不变
    public object Content { get; private set; }

    public DataModel(/* 参数列表 */)
    {
        // 其他属性赋值
        Content = JsonSerializer.Deserialize<object>(contentJson);
    }
}

这种方式实现简单，但object类型序列化时会将JSON类型转为对应的.NET类型，若需严格匹配原始JSON结构，优先选择JsonElement。

方法3：自定义JsonConverter（保留字符串存储） #

如果需要保持Content的存储类型为string（比如数据库存储需求），但序列化时输出为JSON子对象，可以自定义JSON转换器：

1. 实现转换器： #

using System.Text.Json;
using System.Text.Json.Serialization;

public class StringToJsonConverter : JsonConverter<string>
{
    public override string Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        // 反序列化时，将JSON对象转回字符串
        return JsonSerializer.Serialize(reader.GetRawValue(), options);
    }

    public override void Write(Utf8JsonWriter writer, string value, JsonSerializerOptions options)
    {
        // 序列化时，将字符串解析为JSON并直接写入
        using (JsonDocument doc = JsonDocument.Parse(value))
        {
            doc.RootElement.WriteTo(writer);
        }
    }
}

2. 标记Content属性： #

在DataModel的Content属性上添加转换器标记：

[JsonConverter(typeof(StringToJsonConverter))]
public string Content { get; private set; }

这样存储时Content是JSON字符串，但返回前端时会自动转为JSON子对象，同时支持前端传入JSON对象反序列化为字符串存储。

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