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

写在前面

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

需要从NuGet 安装 Swashbuckle.AspNetCore 包

代码实现

cs 复制代码
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();

app.MapGet("/swag", () => "Hello Swagger!");
app.MapGet("/skipme", () => "Skipping Swagger.")
                    .ExcludeFromDescription();

app.Run();

运行示例

相关推荐
Super Rookie3 分钟前
Spring Cloud 企业项目技术选型
后端·spring·spring cloud
程序员爱钓鱼4 小时前
限流、控并发、减GC!一文搞懂Go项目资源优化的正确姿势
后端·google·go
姑苏洛言9 小时前
编写产品需求文档:黄历日历小程序
前端·javascript·后端
姑苏洛言9 小时前
搭建一款结合传统黄历功能的日历小程序
前端·javascript·后端
你的人类朋友9 小时前
🍃认识一下boomi
后端
苏三说技术9 小时前
MySQL的三大日志
后端
豌豆花下猫10 小时前
让 Python 代码飙升330倍:从入门到精通的四种性能优化实践
后端·python·ai
南雨北斗10 小时前
TP6使用PHPMailer发送邮件
后端
你的人类朋友11 小时前
🤔什么时候用BFF架构?
前端·javascript·后端
争不过朝夕,又念着往昔12 小时前
Go语言反射机制详解
开发语言·后端·golang