Swashbuckle v5中模型内IFormFile属性显示上传按钮的问题

我之前也踩过这个坑！当IFormFile是单独参数时Swagger能正常识别，但嵌套在Dto里就会被当成字符串显示，其实是因为两个关键配置没到位：

• 第一步：给接口添加multipart/form-data消费特性
  因为你的Dto同时包含普通文本字段和文件字段，接口必须明确声明支持multipart/form-data类型的请求。在你的POST接口方法上加上[Consumes("multipart/form-data")]：

  [HttpPost("create-device")]
  [Consumes("multipart/form-data")]
  public async Task<IActionResult> CreateDevice(CreateDeviceDto dto)
  {
      // 你的业务逻辑代码
      return Ok();
  }
  

• 第二步：添加Swagger Schema过滤器识别Dto内的IFormFile
  Swashbuckle默认不会自动处理Dto里的IFormFile，需要自定义一个过滤器来修正Schema的类型定义。在Swagger配置里添加这个过滤器：

  // 在Program.cs（或Startup.cs）的AddSwaggerGen配置中
  builder.Services.AddSwaggerGen(c =>
  {
      // 其他Swagger配置，比如标题、版本等
      c.SwaggerDoc("v1", new OpenApiInfo { Title = "Device API", Version = "v1" });
  
      // 添加自定义Schema过滤器
      c.SchemaFilter<FileSchemaFilter>();
  });
  
  // 自定义的Schema过滤器类
  public class FileSchemaFilter : ISchemaFilter
  {
      public void Apply(OpenApiSchema schema, SchemaFilterContext context)
      {
          // 直接处理IFormFile类型
          if (context.Type == typeof(IFormFile))
          {
              schema.Type = "string";
              schema.Format = "binary";
              return;
          }
  
          // 处理Dto里的IFormFile属性
          if (context.Type.IsClass && context.Type != typeof(string))
          {
              foreach (var prop in schema.Properties.ToList())
              {
                  if (prop.Value.Reference?.Id == typeof(IFormFile).Name)
                  {
                      prop.Value.Type = "string";
                      prop.Value.Format = "binary";
                      prop.Value.Reference = null;
                  }
              }
          }
      }
  }
  

做完这两步之后，重启你的API项目，打开Swagger UI就能看到ImageUpload和IconUpload两个属性都显示成文件上传按钮了，普通的OwnerFirstName、OwnerLastName也会正常显示文本输入框。

另外再确认一下你的Dto属性都是public且有getter和setter（你的例子里已经满足），这是Swagger能正确识别属性的前提。

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