在 ASP.NET 的 Startup.cs 文件中,配置 Swagger UI 的时候需要指定 API 文档的 XML 文件路径,并且注意路径大小写和后缀名是否正确。示例代码如下:
public void ConfigureServices(IServiceCollection services)
{
// 添加 Swagger 生成器
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "API 文档", Version = "v1" });
var xmlPath = Path.Combine(AppContext.BaseDirectory, "YourAPIProjectName.xml"); // 请替换为实际的 XML 文件名
c.IncludeXmlComments(xmlPath);
});
// other service configurations...
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "API 文档 v1");
c.RoutePrefix = string.Empty;
});
// other app configurations...
}
请注意,上述示例代码中的“YourAPIProjectName.xml”需要替换为实际的 XML 文件名,并且该 XML 文件需要在项目生成的 bin 目录中可用。
另外,如果 API 控制器中的方法名或参数列表发生了更改,或者 API 路由发生了更改,则需要重新生成 API 文档的 XML 文件,并将其拷贝到正确的路径下。