.NET10 中配置Swagger的记录

项目的.csproj配置

  <ItemGroup>
    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="10.0.5" />  
    <PackageReference Include="Swashbuckle.AspNetCore" Version="10.1.5" />
  </ItemGroup>

项目属性配置

项目属性中
生成->输出->文档文件 勾选生成包含API文档的文件

创建一个多版本管理类

我放在了Utility/ApiVersions.cs  注意这里使用字段不是属性，和后面代码的调用对应，如果使用属性需要同步修改后面Program.cs中的代码

    public class ApiVersions
    {
        public string V1;
        public string V2;
        public string V3;
    }

Program.cs中的代码配置

#region 配置Swagger服务
{
    builder.Services.AddEndpointsApiExplorer();
    builder.Services.AddSwaggerGen(options =>
    {
        #region 支持注释
        string basePath = Path.GetDirectoryName(AppContext.BaseDirectory);
        string xmlPath = Path.Combine(basePath, $"{System.Reflection.Assembly.GetExecutingAssembly().GetName().Name}.xml");
        options.IncludeXmlComments(xmlPath);
        #endregion

        #region 支持多版本
        foreach(FieldInfo field in typeof(ApiVersions).GetFields())
        {
            string version = field.Name;
            options.SwaggerDoc(version, new OpenApiInfo
            {
                Version = version,
                Title = $"One API {version}",
                Description = $"One API接口文档 {version}"
            });
        }
        #endregion
    });
}
#endregion
var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.MapOpenApi();
}
#region 配置Swagger中间件
{
    app.UseSwagger();
    app.UseSwaggerUI(options =>
    {
        foreach (FieldInfo field in typeof(ApiVersions).GetFields())
        {
            string version = field.Name;
            options.SwaggerEndpoint($"/swagger/{version}/swagger.json", $"One API {version}");
        }
        //options.RoutePrefix = string.Empty; // 设置Swagger UI的根路径
    });
}
#endregion

这里重点是两部分配置，一部分配置Swagger服务，放在var app = builder.Build();前面，另一部分，Swagger中间件配置放var app = builder.Build();后面