.NET中的OpenAPI/Swagger是什么？如何为Web API自动生成文档？

OpenAPI（以前称为Swagger）是一个规范和工具集，用于描述和可视化RESTful API。在 .NET 中，通过集成 OpenAPI，可以为 Web API 自动生成交互式文档，帮助开发者快速理解接口的使用方式，包括支持的 HTTP 方法、请求参数、响应格式等。

OpenAPI 与 Swagger 的关系

OpenAPI 是一种开放标准，定义了如何以机器可读的方式描述 REST API。Swagger 是最早实现该规范的一套工具，现在已成为 OpenAPI 生态的一部分。在 .NET 中，“Swagger”常被用来泛指基于 OpenAPI 的文档生成工具。

在 .NET Web API 中启用自动生成文档

从 .NET 5 开始，创建 Web API 项目时默认包含对 OpenAPI 的支持。借助 Swashbuckle.AspNetCore 这个流行库，可以轻松实现文档自动生成和可视化界面展示。

具体操作步骤

1. 安装 NuGet 包

在项目中安装 Swashbuckle.AspNetCore：

2. 配置服务（Program.cs）

在 Program.cs 中注册 Swagger 服务并添加文档生成器：

3. 启用中间件

在开发环境下启用 Swagger 中间件：

运行项目后，访问 /swagger 路径即可看到自动生成的交互式 API 文档页面。

增强文档信息（可选）

你可以进一步自定义文档内容，比如添加标题、版本、描述和 XML 注释。

添加 XML 注释文件：

同时，在项目文件中启用 XML 文档生成：

这样控制器和方法上的 XML 注释就会显示在 Swagger UI 中。

基本上就这些。通过简单配置，.NET 可以为 Web API 提供功能完整的自动文档，极大提升前后端协作效率。不复杂但容易忽略的是确保注释开启和路径正确映射。