Question

我有一个使用Swagger作为API文档的C＃Web API。我已经使用了Swashbuckle软件包。 swagger环境正在与我在控制器中指定的多个版本一起使用。

今天，我介绍了一个仍在开发中的新的未来版本（1.2）。我想默认打开1.1版的swagger，但仍在右上角的下拉列表中保留正确的排序顺序（例如v1，v1.1，v1.2）。当前，它总是在下拉菜单中打开最高版本。

有人知道怎么做吗？

Answer 1

在Startup.cs-Configure方法中配置Swagger UI的顺序确定下拉列表的顺序。默认情况下，UI在下拉列表中显示与第一个选项相对应的规范。

我们可以如下所示更改版本的顺序，但是我不确定在保留UI中版本的下拉顺序的同时是否有任何属性可以覆盖默认版本。

在下面的示例中，默认情况下它将打开v1.1。

app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1.1/swagger.json", "V1.1");
    c.SwaggerEndpoint("/swagger/v1.0/swagger.json", "V1.0");
    c.SwaggerEndpoint("/swagger/v1.2/swagger.json", "V1.2");
}

但是，有一种解决方法：您可以传递querystring参数urls.primaryName的值，以便默认情况下加载该版本。

https://localhost:5001/swagger/index.html?urls.primaryName=v1.1

（或）您可以尝试通过注入自定义javascript来自定义Swagger UI，如下所示：

app.UseSwaggerUI( 
            ....
            c => c.InjectJavascript(***pass custom javascript here***) )

Answer 2

扩展鲍勃的答案：解决方案是编辑Properties / launchSettings.json：

"profiles": {
  "Command.Broker": {
    "commandName": "Project",
    "launchBrowser": true,
    "launchUrl": "swagger/index.html?urls.primaryName=v1.1",
    "environmentVariables": {
      "ASPNETCORE_ENVIRONMENT": "Development"
    },
    "applicationUrl": "http://localhost:51476/"
  },
}

Answer 3

我只是将首页重定向到配置文件中指定的版本。 .net核心示例

...
string SwaggerStartupVersion = "V2";
...

    public void ConfigureApp(IApplicationBuilder app, IWebHostEnvironment env, IApiVersionDescriptionProvider provider)
    {
        app.Use(async (context, next) =>
        {
            var isFrontPage = context.Request.Path.Value == "/index.html" && !context.Request.QueryString.HasValue;
            if (isFrontPage)
            {
                context.Response.Redirect($"/index.html?urls.primaryName={SwaggerStartupVersion}");
                return;
            }

            await next();
        });

我该如何指定swagger的默认打开版本？

3 个答案: