配置支持 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();

运行示例

相关推荐
estarlee几秒前
通用图片搜索-搜狗源免费API接口使用指南
后端
前端极客探险家4 分钟前
Spring Boot + Vue.js 全栈开发:从前后端分离到高效部署,打造你的MVP利器!
vue.js·spring boot·后端
码出极致5 分钟前
Redisson 常用方法介绍
后端
KENYCHEN奉孝11 分钟前
Flask3.1打造极简CMS系统
后端·python·flask
码出极致19 分钟前
Redisson 分布式锁的加锁和解锁原理
后端
vivo互联网技术31 分钟前
vivo Pulsar 万亿级消息处理实践(3)-KoP指标异常修复
java·大数据·服务器·后端·kafka·消息队列·pulsar
00后程序员32 分钟前
iOS 抓包详细教程:从零搭建、操作到实战调试的全流程指南
后端
武子康36 分钟前
大数据-36 HBase 增删改查 列族详解 实测
大数据·后端·hbase
smile_life_40 分钟前
springboot单体项目的发布生产优化
java·spring boot·后端
normaling1 小时前
三、JetStream详解
后端