Swagger UI中无法读取文件问题

Question 1

我已经在应用程序中加入了swagger UI。

当我尝试查看swagger UI时，可以很好地获取API文档，但过一会儿，按钮上会显示一些错误图标。

错误消息如下所示：

[{“ level”：“错误”，“ message”：“无法从文件http：// MYIP / swagger / docs / v1 ”}中读取 ]

我不确定是什么原因造成的。如果我刷新它，它会在几秒钟后显示错误。

Question 2

我猜想“ http：// MYIP / swagger / docs / v1 ”不能公开访问。

默认情况下，swagger ui使用在线验证器：online.swagger.io。如果它无法访问您的招摇网址，那么您将看到该错误消息。

可能的解决方案：

禁用验证：

config.EnableSwagger().EnableSwaggerUi(c => c.DisableValidator());
使您的网站可公开访问
在本地托管验证器：

您可以从以下网址获取验证器：https：//github.com/swagger-api/validator-badge#running-locally

您还需要告诉swaggerui验证器的位置

config.EnableSwagger().EnableSwaggerUi(c => c.SetValidatorUrl(<validator_url>));

Question 3

为了补充已接受的答案...我只是在SwaggerConfig.cs中取消注释了一行。我只想通过禁用验证器来摆脱主要的swagger页面上的红色错误。

// By default, swagger-ui will validate specs against swagger.io's online validator and display the result
// in a badge at the bottom of the page. Use these options to set a different validator URL or to disable the
// feature entirely.
//c.SetValidatorUrl("http://localhost/validator");
c.DisableValidator();

Question 4

如果您使用的是swagger-uigithub存储库中的文件，则可以通过在index.html文件中设置validatorUrl来禁用文件中的模式验证null：

window.onload = function() {

  // Build a system
  const ui = SwaggerUIBundle({
    url: "/docs/open_api.json",
    dom_id: '#swagger-ui',

    validatorUrl : null,   # <----- Add this line

    deepLinking: true,
    presets: [
      SwaggerUIBundle.presets.apis,
      SwaggerUIStandalonePreset
    ],
    plugins: [
      SwaggerUIBundle.plugins.DownloadUrl
    ],
    layout: "StandaloneLayout"
  })

Question 5

如果您将PHP Laravel框架与L5-Swagger一起使用，请取消注释

'validatorUrl' => null,

从配置文件 /config/l5-swagger.php

Question 6

设置this.model.validatorUrl = null;在dist/swagger-ui.js为我工作..

// Default validator
if(window.location.protocol === 'https:') {
  //this.model.validatorUrl = 'https://online.swagger.io/validator';
  this.model.validatorUrl = null;
} else {
  //this.model.validatorUrl = 'http://online.swagger.io/validator';
  this.model.validatorUrl = null;
}

Question 7

对于使用Swashbuckle.OData时遇到类似问题的任何人：

我在将Swagger与我们的OData端点集成时遇到问题（将ODataController用于API和Swashbuckle.OData NuGet包）。我必须为此编写自己的文档过滤器并添加它：

GlobalConfiguration.Configuration
            .EnableSwagger(c =>
                {
                    c.SingleApiVersion("v1", "OurSolution.API");
                    c.DocumentFilter<SwaggerDocumentFilter>();
                    //c.CustomProvider((defaultProvider) => new ODataSwaggerProvider(defaultProvider, c, GlobalConfiguration.Configuration));
                    c.IncludeXmlComments(GetXmlCommentsPath());
                    c.UseFullTypeNameInSchemaIds();
                    c.RootUrl(req => ConfigurationManager.AppSettings["AppUrl"]);
                })
            .EnableSwaggerUi(c =>
            {
                c.DisableValidator();
            });

显然为了避免验证错误，我不得不注释掉设置ODataSwaggerProvider的行并关闭了以上文章中提到的验证器。这使得Swashbuckle.OData的实用性值得怀疑，但我没有测试它与香草Swashbuckle一起使用的功能。

注意：我使用了GitHub页面上描述的Swashbuckle.OData方法，但是它不起作用：根本没有显示任何可能的端点。也许有人知道更好的解决方案。