ASP.NET Core Web API：非必填IFormFile字段在Swagger中触发必填错误

我定义了用于Web API的DTO模型，特意将LogoImage设为非必填以适配实体更新场景，但通过Swagger测试时仍收到该字段必填的验证错误，仅在传入文件时请求可正常执行。

DTO模型代码 #

public class AddUpdateFundHouseDto : DtoBase
{
    [Required]
    public string ShortName { get; set; }

    [Required]
    public string FullName { get; set; }

    public IFormFile LogoImage { get; set; }
}

收到的验证错误 #

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "00-a9e895fe7e88261c7d587b083ad70ba3-6f94424b94e7e2c9-00",
  "errors": {
    "LogoImage": [
      "The LogoImage field is required."
    ]
  }
}

解决办法 #

方法1：使用可空引用类型（推荐）

将LogoImage字段标记为可空类型，让模型绑定和验证明确识别它为非必填项：

public class AddUpdateFundHouseDto : DtoBase
{
    [Required]
    public string ShortName { get; set; }

    [Required]
    public string FullName { get; set; }

    public IFormFile? LogoImage { get; set; } // 添加?标记可空
}

注：此方法要求项目启用C# 8.0及以上的可空引用类型，可通过项目文件中的<Nullable>enable</Nullable>配置开启。

方法2：关闭非空引用类型的隐式必填验证

如果项目未启用可空引用类型，可在Program.cs中配置MVC选项，关闭框架对非空引用类型的自动必填验证：

builder.Services.AddControllers(options =>
{
    options.SuppressImplicitRequiredAttributeForNonNullableReferenceTypes = true;
});

方法3：调整Swagger配置（可选）

若Swagger仍错误显示该字段为必填，需确保Swagger生成器正确识别可选字段。对于启用了可空引用类型的项目，添加以下配置即可：

builder.Services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "你的API名称", Version = "v1" });
    c.SupportNonNullableReferenceTypes();
});

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