配置支持 OpenAPI 的 ASP.NET Core 应用

最新推荐文章于 2025-01-26 19:13:30 发布

原创

最新推荐文章于 2025-01-26 19:13:30 发布 · 1.1k 阅读

8 ·

CC 4.0 BY-SA版权

文章标签：

#asp.net #后端

本文详细介绍了如何在ASP.NETCore中使用Swashbuckle.AspNetCore包来实现Swagger的配置，包括添加控制器、生成API文档和在开发环境中展示UI。

写在前面

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。本文记录如何配置基于Swagger 的 ASP.NET Core 应用程序的 OpenAPI 规范。

需要从NuGet 安装 Swashbuckle.AspNetCore 包

代码实现

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers();
 
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new()
    {
        Title = builder.Environment.ApplicationName,
        Version = "v1"
    });
});


var app = builder.Build();
 
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json",
                                $"{builder.Environment.ApplicationName} v1"));
}

app.UseHttpsRedirection();

app.UseAuthorization();

app.MapControllers();