添加自定义Controller后Swagger加载API定义失败（500错误）求助

在运行中的Swagger环境中添加以下MyController后，出现500错误，无法正常加载API定义：

相关代码 #

MyController.cs #

[Route("api/v1/[controller]")]
[ApiController]
public class MyController : ControllerBase{

        [HttpGet("GetList")]
        public async Task<ResponseModel> GetList([FromBody] GetListRequestModel requestModel)
{...}
}

Startup.cs #

services.AddSwaggerGen(c =>
 {
     c.SwaggerDoc("v1", new OpenApiInfo
     {
         ...
     }
     );
 });

 app.UseSwagger().UseSwaggerUI(c =>
 {
     c.SwaggerEndpoint("/swagger/v1/swagger.json", "v1");
 });

解决方案 #

问题根源 #

[HttpGet]注解的接口方法中使用了[FromBody]参数，违反了HTTP GET请求的规范（GET请求通常不携带请求体）。Swagger在解析这种不符合规范的API定义时会抛出异常，导致返回500错误，无法加载API文档。

修复方式 #

根据业务需求选择以下两种方案之一：

1. 改为POST请求（推荐，适合需要传递复杂参数的场景）
   将[HttpGet]替换为[HttpPost]，保持[FromBody]参数绑定：

   [HttpPost("GetList")]
   public async Task<ResponseModel> GetList([FromBody] GetListRequestModel requestModel)
   {...}
   

2. 保留GET请求，改用查询参数绑定
   移除[FromBody]，改用[FromQuery]让参数从URL查询字符串中获取（需确保GetListRequestModel的属性支持查询字符串绑定）：

   [HttpGet("GetList")]
   public async Task<ResponseModel> GetList([FromQuery] GetListRequestModel requestModel)
   {...}
   

修改完成后重启项目，Swagger即可正常加载API定义，500错误将被解决。

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