Swagger UI 页面在 localhost SSL Url 上为空白

Posted

技术标签:

【中文标题】Swagger UI 页面在 localhost SSL Url 上为空白【英文标题】:Swagger UI page is blank on localhost SSL Url 【发布时间】:2021-08-25 12:08:30 【问题描述】:

我正在开发一个 v5.0.6 ASP.NET Core WebApi 并包含启用了 SwaggerUI 的 Swashbuckle.AspNetCore Swagger。我正在 Windows 10 版本 21H1(OS Build 19043.1023)上使用 Visual Studio 2019 v16.10.0 进行开发。项目属性中的设置是:

    IISExpress 应用网址:http://localhost:64870 IISExpress 启用 SSL URL:https://localhost:44387/ 控制台 http://localhost:5000 和 http://localhost:5001

如果我从 VS2019 启动 WebApi 并提供 URL 'https://localhost:44387/',则 SwaggerUI 页面完全空白,但可以访问 WebApi 并且可以检索数据所以我知道 WebApi 正在工作正如它应该。我可以从任何其他 URL 访问 WebApi,并且 SwaggerUI 页面按原样显示。只有“https://localhost:44387/”的 IISExpress SSL URL 具有空白页面。我花了几个小时解决这个问题,但没有解决方案。

有没有人看到这个问题并有解决方案。

更新:我不得不用新的戴尔 8940 台式机替换我的其他一台开发机器,因此我安装了所有开发软件。使用 GitKraken 拉取源代码。启动Visual Studio 2019,打开博客解决方案。之后,我在新机器上使用它的相关 API 开始了博客,并且 SwaggerUI 工作得非常完美。所以其他机器的设置有些特殊。不知道那是什么,但我希望我能弄清楚,因为那台机器是我的主要开发机器。

有人有什么想法吗?

更新:将我的项目更新到 Swashbuckle v6.1.5,一切都恢复正常了。 Swagger UI 现在正在加载。嗯……

史蒂夫

【问题讨论】:

你设置的默认路由是什么?你试过访问localhost:44387/swagger吗? 默认路由设置在哪里? URL localhost:44387/swagger 给了我一个找不到页面的 404 错误。但是从 VS2019 开始时,空白页面显示 URL 为 localhost:44387/index.html,并且项目中没有 index.html。我以为它来自 SwaggerUI 库。但是 URL localhost:44387/swagger/v1/swagger.json 显示了应有的数据。只有 UI 不能在 IISEXpress SSL 上运行。 【参考方案1】:

很难说是什么问题。

尝试添加 nuget 包 Swashbuckle.AspNetCore.SwaggerGen

在 Startup.cs 'ConfigureServices' 中添加:

            services.AddSwaggerGen(options =>
            
                options.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo()
                
                    Title = "My Api",
                    Version = "1.0"
                );

            );

并在 Startup.cs 'Configure' 中添加:

            app.UseSwagger();

            app.UseSwaggerUI(c =>
            
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "My Api v1");
            );

然后导航到https://localhost:44387/swagger

【讨论】:

您请求的所有代码都已经存在。当导航到localhost:44387/swagger 时,您将收到 HTTP 错误 404。但如果您使用应用程序 URL localhost:64870 或控制台 localhost:5000 和 localhost:5001 URL,一切正常。只有与 IISExpress 一起运行的 SSL URL 上的 SwaggerUI 存在显示 SwaggerUI 的问题。 WebApi 本身可以在使用其数据的网站或使用 localhost:44387 url 的 Postman 中完美运行。 仔细检查您是否使用了 https。这里还有一些关于类似问题的附加信息:***.com/questions/64882011/…【参考方案2】:

检查加载swagger-ui-standalone-preset.js文件是否被杀毒软件阻止。因为这个文件没有加载,所以出现jscript错误如下:

Uncaught ReferenceError: SwaggerUIStandalonePreset is not defined

就我而言,我发现它不仅在 Microsoft Edge 浏览器中工作。 SSL 适用于 Chrome 和 Firefox。

【讨论】:

以上是关于Swagger UI 页面在 localhost SSL Url 上为空白的主要内容,如果未能解决你的问题,请参考以下文章

如何更改 swagger-ui.html 默认路径

如何使用 OpenApi 自定义 swagger-ui.html url

如何让 Swagger 在生成的 HTML(在 Swagger UI 页面中)中添加新行?

SpringBoot整合Swagger,方便后端测试

是否可以在 Swagger ui 之前添加登录页面?

Swagger UI 文档页面前端存储的凭据在哪里?