.NET Core WebApi 之使用 Swagger 进行测试

Swagger 是一种用于构建、文档化和使用 RESTful Web 服务的开源工具。它为我们提供了一个动态生成 API 文档和客户端 SDK 的功能，非常方便。

本文将介绍如何在 .NET Core WebApi 项目中集成 Swagger，并使用 Swagger 进行接口测试。

步骤一：安装 Swagger NuGet 包

打开 Visual Studio，进入 NuGet 包管理器控制台，运行以下命令：

Install-Package Swashbuckle.AspNetCore

这将安装最新的 Swashbuckle.AspNetCore 包，用于集成 Swagger。

在 .NET Core WebApi 项目的 Startup.cs 文件中，找到 ConfigureServices 方法，并添加以下代码：

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});

这将配置 Swagger，并给 API 文档提供一个标题和版本号。

接着，在 Configure 方法中，添加以下代码：

app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});

这将启用 Swagger UI，让我们能够在浏览器中查看和测试 API 文档。

在完成上述配置后，我们需要生成 API 文档。在项目的根目录下，使用命令行工具运行以下命令：

dotnet swagger v1

这将自动生成一个 swagger.json 文件，其中包含了我们的 API 文档信息。

运行项目，在浏览器中访问 https://localhost:<port>/swagger，将会看到一个美观的 Swagger UI 界面。在该界面上，我们可以查看所有的 API 接口，包括请求方式、参数、返回值等信息。

使用 Swagger 进行接口测试非常简单。点击对应的 API 接口，会展开该接口的所有信息。在右侧有一个 "Try it Out" 按钮，点击它将进入测试界面。我们可以在测试界面中输入接口所需的参数，然后点击 "Execute" 按钮发送请求并查看返回结果。

通过集成 Swagger，我们可以轻松地创建和维护 WebApi 的 API 文档。同时，Swagger 提供了一个交互式的界面，方便了接口的测试和调试过程。希望本文能帮助你更好地使用 Swagger 进行 WebApi 开发和测试。

如果你还没有尝试过 Swagger，赶紧来安装和配置一下，让你的 WebApi 开发工作更加高效和有趣吧！