在 ASP.NET Core 中，我们经常需要使用 Swagger UI 来浏览和测试我们的 API 接口。Swagger UI 是一个非常强大的工具，它可以帮助我们自动生成 API 接口的文档并提供一个友好的界面来浏览和测试这些接口。
什么是 Swagger UI？
Swagger 是一个用于描述、生成、浏览和测试 API 接口的规范和工具集。Swagger UI 是 Swagger 的一个组件，它提供了一个用于浏览和测试 API 接口的漂亮界面。
在 ASP.NET Core 中集成 Swagger UI
首先，我们需要安装 Swashbuckle.AspNetCore 包。可以在 NuGet 包管理器中搜索并安装这个包，或者使用以下命令在 Package Manager Console 中进行安装：
Install-Package Swashbuckle.AspNetCore
安装完毕后，我们需要在 Startup.cs 文件的 ConfigureServices 方法中进行配置。以下是一个基本的配置示例：
public void ConfigureServices(IServiceCollection services)
{
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo
{
Title = "My API",
Version = "v1",
Description = "This is a sample ASP.NET Core Web API"
});
});
// ...
}
在上述代码中，我们创建了一个名为 "v1" 的 Swagger 文档，并设置了一些基本信息，如标题、版本和描述。
接下来，在 Startup.cs 文件的 Configure 方法中添加以下代码：
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
// ...
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
c.RoutePrefix = "swagger";
});
// ...
}
在上述代码中，我们启用了 Swagger 中间件，并配置了 Swagger UI 的终结点和路由前缀。
使用 Swagger UI 浏览和测试 API 接口
启动应用程序后，我们可以在浏览器中访问 /swagger 地址，即可打开 Swagger UI。
在 Swagger UI 中，我们可以看到生成的 API 接口文档。它将根据我们在配置文件中设置的信息生成文档，包括接口的 URL、参数、返回值等信息。
除了浏览 API 接口文档外，Swagger UI 还提供了一个用户友好的界面来测试 API 接口。我们可以在 UI 中输入接口所需的参数，并点击 "Try it out" 按钮来发送请求并查看结果。
小结
在 ASP.NET Core 应用程序中使用 Swagger UI 可以帮助我们更方便地浏览和测试 API 接口。通过集成 Swagger UI，我们不仅可以生成 API 接口的文档，还可以提供一个友好的界面来测试这些接口。
希望这篇博客对你使用 ASP.NET Core 和 Swagger UI 带来帮助。如果你对该主题还有其他问题或需求，请留言让我知道，我将竭诚为你提供帮助。
本文来自极简博客，作者：星辰之海姬，转载请注明原文链接：在 ASP.NET Core 中使用 Swagger UI 浏览和测试 API 接口
