如何在ASP.NET Core的GET请求返回的JSON中排除指定模型字段？

你可以根据自己的需求选择以下任意一种方式实现忽略PhotoID字段：

方案1：添加[JsonIgnore]特性（最简单） #

直接在你的Photo实体类的PhotoID属性上标记序列化忽略特性即可，全局所有返回该实体的接口都会自动忽略该字段：

// 如果你用ASP.NET Core默认的System.Text.Json序列化，引入这个命名空间
using System.Text.Json.Serialization;
// 如果你用的是Newtonsoft.Json，替换为 using Newtonsoft.Json;

public class Photo
{
    // 标记后该字段不会被序列化为JSON
    [JsonIgnore]
    public int PhotoID { get; set; }

    // 其他需要保留的字段
    public string ImageUrl { get; set; }
    public int SortOrder { get; set; }
}

方案2：使用DTO做返回字段裁剪（推荐最佳实践） #

直接暴露数据库实体到接口响应本身存在安全风险，更推荐你定义专门的返回数据传输对象（DTO），仅保留需要返回的字段，完全不定义PhotoID即可：

1. 先定义DTO类

// 图片返回DTO，只保留需要的字段
public class PhotoResponseDto
{
    public string ImageUrl { get; set; }
    public int SortOrder { get; set; }
}

// 商品返回DTO
public class ClothesItemResponseDto
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Type { get; set; }
    public List<PhotoResponseDto> Photos { get; set; }
    // 其他需要返回的商品字段
}

2. 修改你的接口代码，把查询到的实体映射到DTO后再返回：

var result = new
{
    items = clothesItems.Select(item => new ClothesItemResponseDto
    {
        Id = item.Id,
        Name = item.Name,
        Type = item.Type,
        Photos = item.Photos.Select(photo => new PhotoResponseDto
        {
            ImageUrl = photo.ImageUrl,
            SortOrder = photo.SortOrder
        }).ToList()
        // 其他字段赋值
    }),
    total = itemsCount,
    statusCode = responsesStatusCode,
};

return new JsonResult(result);

这种方案灵活度最高，不同接口可以按需定制返回字段，也能避免暴露数据库敏感字段。

方案3：自定义序列化规则（临时场景适用） #

如果你不想修改实体类、也不想新增DTO，只需要在当前接口忽略该字段，可以在返回JsonResult时自定义序列化配置，移除PhotoID字段：

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

return new JsonResult(result, new JsonSerializerOptions
{
    TypeInfoResolver = new DefaultJsonTypeInfoResolver
    {
        Modifiers =
        {
            typeInfo => 
            {
                // 匹配Photo类，移除PhotoID字段的序列化配置
                if (typeInfo.Type == typeof(Photo))
                {
                    var photoIdProp = typeInfo.Properties.FirstOrDefault(p => p.Name == nameof(Photo.PhotoID));
                    if (photoIdProp != null)
                    {
                        typeInfo.Properties.Remove(photoIdProp);
                    }
                }
            }
        }
    }
});

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