C# WebAPI Swagger如何显示接口注释

废话不多说直接上教程

1️⃣ 打开 XML 注释生成

在 项目属性 → 生成 → 输出中勾选：

生成包含API文档的文件

---

2️⃣ Program.cs 配置 Swagger

builder.Services.AddSwaggerGen(c =>
{//这个xmlPath路径必须与上一个XML 文档文件路径对应var xmlPath = Path.Combine(AppContext.BaseDirectory, "MyApiDemo.xml");if (File.Exists(xmlPath))c.IncludeXmlComments(xmlPath, true);
});

---

3️⃣ 给控制器和方法加注释

 /// <summary>/// 我是接口AA/// </summary>/// <param name="a">我是参数AA</param>/// <returns></returns>[HttpGet("A")]public IActionResult A(string a){return Ok("a");}

Swagger UI 就会自动显示 summary 内容。

结果看下图