c#实现与swagger UI自动关联

最新推荐文章于 2025-10-27 12:42:32 发布

原创

最新推荐文章于 2025-10-27 12:42:32 发布 · 727 阅读

7 ·

CC 4.0 BY-SA版权

文章标签：

#c# #ui #开发语言

C#实现与Swagger UI自动关联

在C#项目中，Swagger UI是一个用于自动生成和可视化API文档的工具，它能与你的API端点自动关联，无需手动编写文档。通过Swashbuckle库（适用于ASP.NET Core），我们可以轻松实现这一功能。下面我将逐步指导你完成整个过程，确保结构清晰、易于操作。整个流程基于.NET Core或.NET 5/6/7/8环境。

步骤1: 准备工作

确保环境：你需要安装.NET SDK（建议版本6.0或更高）和IDE（如Visual Studio或VS Code）。
创建项目：如果还没有项目，创建一个新的ASP.NET Core Web API项目：
- 使用命令行：dotnet new webapi -n MyApiProject
- 或在Visual Studio中新建"ASP.NET Core Web API"项目。
添加依赖：添加Swashbuckle.AspNetCore NuGet包（这是实现Swagger UI的核心库）：
- 使用命令行：dotnet add package Swashbuckle.AspNetCore
- 或在Visual Studio的NuGet包管理器中搜索并安装。

步骤2: 配置Swagger服务

在项目中，打开Program.cs文件（或Startup.cs，如果使用旧版.NET）。添加服务配置和中间件启用Swagger UI。以下是完整代码示例：

var builder = WebApplication.CreateBuilder(args);

// 添加服务到容器
builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();

// 配置Swagger生成器
builder.Services.AddSwaggerGen(c =>
{
   
   
    c.SwaggerDoc("v1", new OpenApiInfo {
   
    Title = "My API", Version = "v1" });
});

var app = builder.Build()