ASP.NET Core集成Swagger生成API文档方法

ASP.NET Core 项目集成 Swagger 需四步：1. 安装 Swashbuckle.AspNetCore 包；2. 在 Program.cs 中配置 AddEndpointsApiExplorer、AddSwaggerGen 及 UseSwagger/UseSwaggerUI；3. 启用 XML 注释并配置读取路径以增强文档信息；4. 可选支持多版本，通过 SwaggerDoc 和 SwaggerEndpoint 实现。

ASP.NET Core 项目中集成 Swagger（即 Swashbuckle.AspNetCore）是生成 OpenAPI 接口文档最常用、最标准的方式。它能自动扫描控制器和 API 方法，生成交互式文档页面，并支持测试接口。

1. 安装 Swashbuckle.AspNetCore 包

在项目中通过 NuGet 安装核心包：

• Swashbuckle.AspNetCore（主包，含生成器、UI 和中间件）

可通过 CLI 命令安装：

2. 配置服务与中间件（Program.cs）

.NET 6+ 项目统一在 Program.cs 中配置：

• 调用 AddEndpointsApiExplorer()（必需，为 API 端点提供元数据）
• 调用 AddSwaggerGen() 添加 Swagger 生成器
• 在管道中使用 UseSwagger() 和 UseSwaggerUI()

示例代码：

3. 添加接口注释与增强文档信息

默认只显示方法名和路径。要显示更详细的描述、参数说明、返回值等，需启用 XML 注释：

• 在项目文件（.csproj）中添加：<GenerateDocumentationFile>true</GenerateDocumentationFile>
• 在 AddSwaggerGen() 中配置读取 XML 文件：

并在控制器/方法上写三斜杠注释，例如：

4. 支持多版本 OpenAPI 文档（可选）

如需支持 v1/v2 多版本 API，可配置多个 Swagger 文档：

• 在 AddSwaggerGen() 中定义多个 c.SwaggerDoc("v1", ...)
• 用 UseSwaggerUI() 指定默认版本和切换入口

示例片段：

基本上就这些。启动应用后访问 /swagger 即可看到交互式文档页面，所有标记了 HTTP 特性的控制器方法都会自动列出。