SwashBuckle：GET请求FromQuery参数示例值无法预填如何解决

我之前也遇到过这个一模一样的问题——SwashBuckle的示例提供者对POST请求体支持得很顺畅，但对GET的Query参数DTO就没那么“贴心”了。核心原因很简单：POST的请求体是一个完整的JSON对象，Swagger UI可以直接复用你定义的示例；而GET的Query参数是分散的键值对，默认情况下SwashBuckle不会自动把DTO的示例拆解到每个参数输入框里。

下面给你两种纯属性/配置驱动的解决方案，完全不需要设置参数默认值：

方法一：直接在DTO属性上标注示例（最直接高效） #

如果只是给单个参数设置简单的示例值，直接用SwaggerParameter属性就能搞定，不需要额外的IExamplesProvider类：

public class ExampleDTO {
    [FromQuery(Name = "foo")]
    [SwaggerParameter(Example = "bar")] // 这里直接指定示例值
    public string MyFoo { get; set; }
}

配置完成后，Swagger UI的foo参数输入框会自动预填bar，完全符合你的需求，而且不会影响API的实际参数绑定逻辑。

方法二：复用IExamplesProvider（适合复杂示例或统一管理） #

如果你还是想通过IExamplesProvider来统一管理示例值（比如示例值需要动态生成、多个接口复用同一套示例规则），需要调整Swagger的配置，让它把DTO的示例拆解到每个Query参数上：

1. 保留你原来的ExampleDTOExample类：

public class ExampleDTOExample : IExamplesProvider<ExampleDTO> {
    public ExampleDTO GetExamples() {
        return new ExampleDTO() { MyFoo = "bar" };
    }
}

2. 在Swagger配置中启用注解和示例过滤器：
   在你的Program.cs（或Startup.cs）里，更新Swagger的注册代码：

builder.Services.AddSwaggerGen(c =>
{
    // 启用Swagger注解支持
    c.EnableAnnotations();
    // 添加示例操作过滤器，让它处理Query参数的示例映射
    c.OperationFilter<ExamplesOperationFilter>();
});

// 注册当前程序集中的所有示例提供者
builder.Services.AddSwaggerExamplesFromAssemblyOf<ExampleDTOExample>();

3. 确保控制器方法上的[FromQuery]标注正确：

[SwaggerOperation(Summary = "...", Description = "...", OperationId = "GetFoo")]
[SwaggerResponse(200, "Returns ...", typeof(int))]
[HttpGet]
[Route("get-foo")]
public ActionResult<int> GetFoo([FromQuery]ExampleDTO request) {
    throw new NotImplementedException();
}

这样配置后，Swagger会自动把ExampleDTOExample生成的示例值拆解到对应的Query参数输入框中，实现预填效果，同时完全不会影响API的参数默认值逻辑。

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