在 ASP.NET Web API 项目中集成 Swagger

引言

当你创建一个新的 ASP.NET Web API 项目时，是否需要以简单且全面的方式展示你的 API？ 你可以使用 Swagger。

“Swagger 是你 RESTful API 的一个简单但强大的表示。 借助全球最大的 API 工具生态系统，数千名开发者正在几乎每种现代编程语言和部署环境中支持 Swagger。 通过启用 Swagger 的 API，你可以获得交互式文档、客户端 SDK 生成和可发现性。”

• swagger.io

背景

能够创建 ASP.NET Web API 2.0。 使用 Postman。

将 Swagger 添加到 WEB API 项目

要将 Swagger 添加到 ASP.NET Web API，我们将通过 NuGet 安装一个名为 Swashbuckle 的开源项目。

当我们安装该包时，添加了一个新的配置文件：SwaggerConfig，如图所示

Swagger 配置

在添加的配置文件中，我们找到了启用 Swagger 和 Swagger UI 所需的最低配置

现在，当我们启动一个新的调试会话时，我们获得了 API 的 URI，并导航到 Swagger：https://:[PORT_NUM]/swagger

如果我们想要显示我们的 API

那么文档呢？

如果我们对代码进行了注释，我们可以启用 XML 注释以在 Swagger 中显示它。

在解决方案资源管理器中，右键单击 Web API 项目，然后单击属性。 单击构建选项卡，然后导航到输出。 确保选中XML 文档文件。 你可以保留默认文件路径。 在我的例子中，它是bin\SwaggerSolution.Services.XML。

在 Swagger 的配置文件中（SwaggerConfig）启用注释后

现在，让我们运行项目并看看。 :)

我将此项目添加为一个扩展，以便你可以轻松地在你的项目中使用的。