Swashbuckle版本控制选择默认API版本以显示在Swagger中

Question

我正在对API进行版本控制，并且我希望在Swagger中显示最新的API版本作为默认版本。例如，我的API有2个版本，当有人选择显示Swagger时，首先出现的版本是V1.0。用户必须手动选择要显示的最新版本。

在下图中，我们可以看到在应用程序启动时显示给用户的默认版本是V1.0。

我想知道默认情况下是否可以向用户显示最新的API版本。

谢谢！

Answer 1

首先，我在Startup.cs的Configure类中添加了IApiVersionDescriptionProvider，如下所示：

此后，我不得不反转包含应用程序中可用的api版本的列表。UseSwaggerUI（）。

在Startup.cs Configure方法中配置Swagger UI的顺序确定下拉列表的顺序。

        app.UseSwaggerUI(c =>
        {
            foreach (var description in apiVersionDescriptionProvider.ApiVersionDescriptions.Reverse())
            {
                // Create the Swagger endpoints for each version
                c.SwaggerEndpoint($"/swagger/" +
                    $"LibraryOpenAPISpecification{description.GroupName}/swagger.json",
                    description.GroupName.ToUpperInvariant());
            }
            c.RoutePrefix = ""; // swagger UI at the root index.html
        });

@Bob Ash的以下回答非常有帮助-How can i specify the default opening version of swagger?

这样做，我现在成功地将V2.0显示为api的默认版本：

Answer 2

我的解决方案是在以下代码块中添加一个 OrderByDescending 子句：

// build a swagger document and endpoint for each discovered API version
c.MultipleApiVersions(
    (apiDescription, version) => apiDescription.GetGroupName() == version,
    info =>
    {
        foreach (var group in apiExplorer.ApiDescriptions.OrderByDescending(p => p.ApiVersion))
        {
            var description = "My Company API";
    
            info.Version(group.Name, $"My Company API {group.ApiVersion}")
                .Contact(ca => ca.Name("My Company).Email("info@mycompany.com"))
                .Description(description)
                .License(l => l.Name("My Company").Url("https://mycompany.com"))
                .TermsOfService("");
        }
    });

在我的情况下，我还根据我的需要使用该迭代来应用一些 UI 细节。