.NET 6 WebAPI中Swashbuckle参数只读，如何设置为可编辑？

常见原因及修复步骤 #

1. 匹配HTTP方法与参数位置 #

如果API使用GET方法，Swagger默认会将参数解析为URL查询字符串，这类参数是可编辑的。但如果GET方法试图接收请求体（RequestBody），Swagger UI会将参数置灰——因为HTTP规范中GET通常不携带请求体，Swashbuckle会识别这种不规范定义并禁用编辑。

• 修复方案：要么将参数改为URL查询/路由参数，要么把HTTP方法换成POST/PUT/PATCH。

2. 正确标记请求体参数 #

对于POST/PUT等方法的请求体参数，必须用[FromBody]特性标记，Swashbuckle才能正确识别并生成可编辑区域：

[HttpPost]
public IActionResult Create([FromBody] UserDto user)
{
    // 业务逻辑代码
    return Ok();
}

缺少[FromBody]标记时，Swagger可能无法识别请求体参数，导致无法编辑。

3. 检查Swashbuckle基础配置 #

在Program.cs中确保Swagger配置完整，没有遗漏核心项：

builder.Services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "你的API名称", Version = "v1" });
    // 可选：启用XML注释（需在项目属性中开启XML文档生成）
    var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
    c.IncludeXmlComments(xmlPath);
});

// 启用Swagger UI中间件
app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "你的API V1");
    // 可选：设置Swagger UI为默认启动页
    c.RoutePrefix = string.Empty;
});

4. 确保参数模型可访问 #

接收参数的DTO类必须是public，且属性包含公开的get和set方法：

public class UserDto
{
    public string Name { get; set; } // 必须有set才能在Swagger中编辑
    public int Age { get; set; }
}

若属性只有get或类为内部类，Swagger UI会无法编辑对应字段。

参考文章核心内容翻译 #

你参考的英文文章核心配置步骤翻译如下：

1. 安装Swashbuckle.AspNetCore包：在NuGet包管理器中搜索并安装Swashbuckle.AspNetCore（包含Swagger生成器和UI组件）。
2. 配置Swagger生成器：在Program.cs的builder.Services中添加AddSwaggerGen，指定API标题和版本，可选添加XML注释增强文档可读性。
3. 启用Swagger中间件：在app构建管道中添加UseSwagger和UseSwaggerUI，指定Swagger文档端点路径，可选设置默认启动页为Swagger UI。
4. 测试API：启动项目后访问/swagger路径（若设置默认启动页则直接访问根路径），即可查看生成的文档并编辑参数测试接口。

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