.net swagger api 开启跨域开启注释

原创已于 2026-05-09 14:17:50 修改 · 111 阅读

1 ·

本内容遵循CC 4.0 BY-SA版权协议

GEO检测

标签

#.net #java #前端

收录于

于 2026-05-09 14:04:57 首次发布

Program.cs

var builder = WebApplication.CreateBuilder(args);

// 1. 添加控制器与 Swagger
builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();

// 配置 Swagger 支持 XML 注释
builder.Services.AddSwaggerGen(options =>
{
    // 获取项目名称
    var xmlFilename = $"{System.Reflection.Assembly.GetExecutingAssembly().GetName().Name}.xml";
    // 加载 XML 注释文件（true 表示包含控制器注释）
    options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename), true);
});

builder.Services.AddSwaggerGen();
builder.Services.AddControllers().AddJsonOptions(options => { options.JsonSerializerOptions.PropertyNamingPolicy = null; });   // 关闭 首字母小写

// 2. 注册 CORS 并定义策略（开发环境全开放）
builder.Services.AddCors(options =>
{
    options.AddPolicy("AllowAll", policy =>
    {
        policy.AllowAnyOrigin()    // 允许所有来源
              .AllowAnyMethod()    // 允许所有 HTTP 方法
              .AllowAnyHeader();   // 允许所有请求头
    });
});

var app = builder.Build();

// 3. 开发环境启用 Swagger
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseSwagger();
app.UseSwaggerUI();

//app.UseSwagger();
//app.UseSwaggerUI(c =>
//{
//    c.SwaggerEndpoint("v1/swagger.json", "测试api");
//});

// 4. 启用 CORS 中间件（顺序关键：UseCors 必须在 UseAuthorization、MapControllers 之前）
app.UseCors("AllowAll");

app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();

app.Run();