ASP.NET Core 9 Web Api 启用 Swagger

赵庆明老师2025-11-03 11:59

摘要

这是一个.NET 9.0 Web项目配置，集成了Swagger文档生成功能。

项目文件中引用了Swashbuckle.AspNetCore 9.0.6包。

代码部分展示了如何在Startup中添加Swagger服务：

通过AddSwaggerGen()注册文档生成器，然后使用UseSwagger()生成JSON文档(默认路径：/swagger/v1/swagger.json)，并通过UseSwaggerUI()提供可视化界面(http://localhost:端口号/swagger)。

这种配置为API提供了自动化的文档生成和测试界面。

bash 复制代码

<Project Sdk="Microsoft.NET.Sdk.Web">

  <PropertyGroup>
    <TargetFramework>net9.0</TargetFramework>
    <Nullable>enable</Nullable>
    <ImplicitUsings>enable</ImplicitUsings>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Swashbuckle.AspNetCore" Version="9.0.6" />
  </ItemGroup>

</Project>

csharp 复制代码

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddMvc();
//注册 Swagger 生成器服务，用于自动生成 API 文档（基于代码中的控制器和方法）
//使用默认配置生成一个名为 v1 的 API 文档，无需额外参数即可工作。
builder.Services.AddSwaggerGen();

var app = builder.Build();

//启用 Swagger 中间件，用于生成 Swagger 文档的 JSON 格式数据（默认路径为 /swagger/v1/swagger.json）
app.UseSwagger();
//启用 Swagger UI 中间件，提供一个可视化的 Web 界面用于查看和调试 API。
//默认访问地址为 http://localhost:端口号/swagger，界面会加载 UseSwagger() 生成的 JSON 文档。
app.UseSwaggerUI();

app.Run();