如何让Swagger-UI为ASP.NET Core接口的类实例参数显示表单？

针对你遇到的Swagger-UI无法识别类实例参数、不生成对应表单的问题，可通过以下几步配置调整解决：

1. 给接口参数添加[FromForm]特性 #

默认情况下，ASP.NET Core Web API会将复杂类型参数绑定到JSON请求体，Swashbuckle据此生成JSON编辑框。要让Swagger识别为表单参数，需显式给参数标记[FromForm]：

[HttpPost]
public IActionResult CreateUser([FromForm] UserCreateDto userDto)
{
    // 接口业务逻辑
    return Ok();
}

// 对应的DTO类示例
public class UserCreateDto
{
    public string Username { get; set; }
    public string Email { get; set; }
    [Range(18, 100)]
    public int Age { get; set; }
}

2. 配置Swashbuckle支持表单参数的Schema生成 #

若添加[FromForm]后仍无表单显示，需在Swagger配置中确保启用form-data类型参数的支持。在Program.cs（或Startup.cs）的AddSwaggerGen方法中补充以下配置：

builder.Services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "你的API名称", Version = "v1" });
    
    // 确保复杂类型表单参数能正确生成Schema
    c.UseAllOfToExtendReferenceSchemas();
    // 可选：统一参数命名为驼峰式，和前端习惯对齐
    c.DescribeAllParametersInCamelCase();
});

3. 检查DTO类的属性配置 #

确保DTO类的属性具备公共可读写访问器，Swagger无法识别私有、只读或无set方法的属性：

// 错误示例：无set方法，Swagger无法生成表单项
public string Username { get; }

// 正确示例：公共可读写属性
public string Username { get; set; }

4. 验证HTTP方法与参数绑定的匹配性 #

确保接口使用的HTTP方法（如[HttpPost]、[HttpPut]）适合接收表单数据，避免同时混用[FromBody]和[FromForm]导致的冲突。若需同时支持JSON和表单提交，可拆分不同接口或使用特性路由区分请求方式。

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