如何在 v5 中定义 Swagger 的相对路径

Question

我正在将我的.NET Core应用程序从Swashbuckle v4升级到v5。 我目前在Startup.ConfigureServices中有以下代码来定义相对路径：

app.UseSwagger(c => {
    c.PreSerializeFilters.Add((swaggerDoc, httpReq) => swaggerDoc.BasePath = "/folder/data");
});

我在将其转换为 v5 时遇到问题。 我尝试了以下内容，但看不到在哪里设置路径：

c.PreSerializeFilters.Add((swagger, httpReq) =>
{
    var paths = new OpenApiPaths();
    var pathItem = new OpenApiPathItem();
    paths.Add("main", pathItem);
    swagger.Paths = paths;
});

Answer 1

在 v5 中，basePath 根据以下内容替换为服务器： https://github.com/domaindrivendev/Swashbuckle.AspNetCore/issues/1173

您可以使用 routeTemplate 设置 json 文件的路径，以及使用服务器从 ui 发出的请求的路径：

var basePath = "/v1";
 app.UseSwagger(c =>
    {
         c.RouteTemplate = "swagger/{documentName}/swagger.json";
         c.PreSerializeFilters.Add((swaggerDoc, httpReq) =>
    {
            swaggerDoc.Servers = new List<OpenApiServer> { new OpenApiServer 
                 { Url = $"{httpReq.Scheme}://{httpReq.Host.Value}{basePath}" } };
        });
    });

要配置 UI，请执行以下操作：

app.UseSwaggerUi(options => 
     {
         options.swaggerEndpoint($"swagger/{apiVersion}/swagger.json, "my api v1");
     }

相对路径可用于使用 ./或 .. 的端点。/