能否通过Swashbuckle为.NET Web API端点添加方法名至文档？

我之前也碰到过类似的困扰——旧API的方法名藏着不少业务上下文信息，但Swashbuckle默认只会识别控制器名称，完全没把方法名的价值利用起来。给你几个实用的解决思路：

1. 自定义操作ID（OperationId），强制带上方法名 #

Swashbuckle生成的每个API操作都有一个OperationId，默认规则可能没包含方法名，我们可以手动改写这个规则，让它把控制器名和方法名组合起来。

在你的配置文件里（.NET 5及以前是Startup.cs，.NET 6+是Program.cs），找到Swagger的配置代码，添加自定义操作ID的逻辑：

services.AddSwaggerGen(c =>
{
    // 让OperationId = 控制器名_方法名
    c.CustomOperationIds(apiDesc => 
    {
        if (apiDesc.TryGetMethodInfo(out MethodInfo methodInfo))
        {
            var controllerName = apiDesc.ActionDescriptor.RouteValues["controller"];
            return $"{controllerName}_{methodInfo.Name}";
        }
        return null;
    });
});

配置完之后，Swagger文档里的每个操作都会带上类似CatalogAvailability_GetSuppliers这样的ID，在Swagger UI里，你能在每个端点的详情里看到这个标识，直接关联到对应的方法名。

2. 给API添加显式注释，把方法名融入文档说明 #

如果希望在Swagger UI里更直观地看到方法名（比如作为端点的标题或描述），可以用XML注释或者Swashbuckle的特性来实现：

方式一：用XML注释（推荐，适合批量处理） #

首先在项目属性里开启XML文档生成：右键项目→属性→生成→勾选“XML文档文件”。
然后在Swagger配置里引入这个XML文件：

services.AddSwaggerGen(c =>
{
    var xmlFileName = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    var xmlFilePath = Path.Combine(AppContext.BaseDirectory, xmlFileName);
    c.IncludeXmlComments(xmlFilePath);
});

接下来在你的API方法上添加XML注释，把方法名明确写进去：

/// <summary>
/// 获取可用供应商列表（对应方法：GetSuppliers）
/// </summary>
/// <returns>供应商名称字符串列表</returns>
public List<string> GetSuppliers()
{
    // 业务逻辑代码
}

方式二：用Swashbuckle特性（适合单个方法定制） #

直接给方法加上[SwaggerOperation]特性，指定摘要和操作ID：

[SwaggerOperation(Summary = "获取可用供应商列表", OperationId = "CatalogAvailability_GetSuppliers")]
public List<string> GetSuppliers()
{
    // 业务逻辑代码
}

3. （可选）自定义Swagger UI样式强化显示 #

如果觉得默认UI里的方法名不够显眼，还可以自定义Swagger UI的样式，比如把操作ID放大或者高亮显示。不过这个步骤相对复杂，一般前面两个方案就足够满足需求了，如果你需要的话，可以通过UseSwaggerUI的InjectStylesheet方法注入自定义CSS来调整。

这些方案里，自定义OperationId是最直接让Swashbuckle“识别”方法名的方式，结合XML注释能让文档既准确又易懂，很适合处理旧API的文档生成需求。

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