ASP.NET ApiController用Consumes配置多请求类型遇Swagger冲突

问题描述 #

尝试让POST api/questions端点同时接收application/json和multipart/form-data类型请求，参照文档编写了以下代码：

private IActionResult CreateQuestion(QuestionCreateDto question)
{
    // 业务逻辑
}

[HttpPost("questions")]
[Consumes("application/json")]
public IActionResult CreateQuestionJson(QuestionCreateDto question)
{
    return CreateQuestion(question);
}

[HttpPost("questions")]
[Consumes("multipart/form-data")]
public IActionResult CreateQuestionForm([FromForm] QuestionCreateDto question)
{
    return CreateQuestion(question);
}

但启动后Swagger UI抛出错误：

SwaggerGeneratorException: Conflicting method/path combination "POST api/questions" for actions -
[MyProject].Controllers.QuestionController.CreateQuestionJson (MyProject), [MyProject].Controllers.QuestionController.CreateQuestionForm (MyProject).
Actions require a unique method/path combination for Swagger/OpenAPI 3.0.
Use ConflictingActionsResolver as a workaround

解决方法 #

方案1：合并为单个Action（推荐） #

无需拆分两个Action，直接在同一Action上声明支持的两种内容类型，并兼容两种绑定方式：

[HttpPost("questions")]
[Consumes("application/json", "multipart/form-data")]
public IActionResult CreateQuestion([FromBody] [FromForm] QuestionCreateDto question)
{
    // 业务逻辑
    return Ok();
}

ASP.NET Core会根据请求的Content-Type自动匹配对应的绑定规则（JSON请求用FromBody绑定，表单请求用FromForm绑定）。需确保QuestionCreateDto的结构兼容两种绑定场景，避免包含无法被表单绑定的复杂嵌套类型。

方案2：保留双Action并修复Swagger冲突 #

若需保留两个独立的Action，可通过配置Swagger的冲突解析器来合并接口文档：
在Program.cs的Swagger配置代码中添加：

builder.Services.AddSwaggerGen(options =>
{
    options.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());
});

该配置会让Swagger在遇到路径和请求方法完全相同的Action时，仅采用第一个Action的描述生成文档。但需手动补充接口注释，明确说明端点支持两种请求类型，避免Swagger文档信息缺失。

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