如何在.NET 6微服务中用构建后生成的swagger.json替代运行时文件？

完全可以实现，核心思路是让Swagger UI直接加载你预先生成的静态swagger.json文件，同时移除运行时生成文档的相关逻辑，具体步骤如下：

1. 确保预先生成的swagger.json可被静态访问 #

首先要保证你的构建后命令生成的swagger.json文件能被应用作为静态文件提供访问：

• 如果生成的文件放在项目默认的wwwroot/swagger/v1目录下，只需要在Program.cs中保留默认的静态文件中间件即可：

  app.UseStaticFiles();
  

• 如果文件放在自定义目录（比如项目根目录的SwaggerOutput），需要额外配置静态文件提供商：

  using Microsoft.Extensions.FileProviders;
  using System.IO;
  
  // 放在app.UseRouting()之后，app.UseEndpoints()之前
  app.UseStaticFiles(new StaticFileOptions
  {
      FileProvider = new PhysicalFileProvider(Path.Combine(Directory.GetCurrentDirectory(), "SwaggerOutput")),
      RequestPath = "/swagger/v1" // 让文件可通过此URL路径访问
  });
  

2. 修改Swagger服务与UI配置 #

移除运行时生成swagger.json的逻辑，让Swagger UI直接指向静态文件：

var builder = WebApplication.CreateBuilder(args);

// 移除或注释掉原来的AddSwaggerGen中用于运行时生成文档的配置（比如SwaggerDoc、OperationFilter等）
// 保留AddSwaggerGen仅为SwaggerUI提供必要依赖（亲测保留更稳妥，避免UI报错）
builder.Services.AddSwaggerGen();

var app = builder.Build();

// 移除app.UseSwagger()——这是提供运行时生成swagger.json的端点，现在不需要了
// 直接配置SwaggerUI指向静态文件
app.UseSwaggerUI(c =>
{
    // 指向预先生成的swagger.json的访问路径
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "我的微服务API V1");
    // 可选：隐藏模型列表，减少UI加载压力
    c.DefaultModelsExpandDepth(-1);
    // 可选：设置UI默认显示的文档标题
    c.DocumentTitle = "预先生成的API文档";
});

app.Run();

3. 保障部署时文件存在 #

• 本地调试时，确保构建后命令生成的文件路径正确，示例构建后命令：

  dotnet swagger tofile --output wwwroot/swagger/v1/swagger.json $(OutputPath)$(AssemblyName).dll v1
  

• Docker或CI/CD部署时，在.csproj中添加配置，确保swagger.json被复制到输出目录：

  <ItemGroup>
    <None Update="wwwroot/swagger/v1/swagger.json">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
  </ItemGroup>
  

注意事项 #

• 每次修改API接口或模型后，必须重新执行构建命令生成最新的swagger.json，否则文档会与实际API不匹配
• 如果有多版本API，需要为每个版本生成对应的swagger.json文件，并在SwaggerUI中添加多个SwaggerEndpoint
• 可以通过完全移除AddSwaggerGen的相关配置，进一步降低应用启动开销

内容的提问来源于stack exchange，提问作者Emanuele