捕获Swagger引发的异常

Question

我是Swagger的新手，所以我可能会问一个愚蠢的问题。 是否可以通过任何方式防止“无法从api读取”网站崩溃？

我的网站大部分时间都在工作，但是如果由于某种原因出现一个无法读取（或无法访问）的api，请停止工作。 它仍然显示它设法到达的api，但是所有功能完全消失了，甚至无法扩展行。

总结一下：

当一个或多个API无法读取并返回如下内容时，如何防止摇摇欲坠：

无法从路径http://example.com/swagger/api-docs/XXXX读取api“ XXXX”（服务器返回未定义）

以下是我对Swagger的初始化：

function loadSwagger() {
window.swaggerUi = new SwaggerUi({
    url: "/frameworks/swagger/v1/api.json",
    dom_id: "swagger-ui-container",
    supportedSubmitMethods: ['get', 'post', 'put', 'delete'],
    onComplete: function (swaggerApi, swaggerUi) {
        log("Loaded SwaggerUI");

        if (typeof initOAuth == "function") {

            initOAuth({
              clientId: "your-client-id",
              realm: "your-realms",
              appName: "your-app-name"
            });

        }
        $('pre code').each(function (i, e) {
            hljs.highlightBlock(e);
        });
    },
    onFailure: function (data) {
        log("Unable to Load SwaggerUI");
    },
    docExpansion: "none",
    sorter: "alpha"
});

$('#input_apiKey').change(function () {
    var key = $('#input_apiKey')[0].value;
    log("key: " + key);
    if (key && key.trim() != "") {
        log("added key " + key);
        window.authorizations.add("api_key", new ApiKeyAuthorization('api_key', key, 'header'));
    }
});

$('#apiVersionSelectID').change(function () {
    var sel = $('#apiVersionSelectID').val();
    window.swaggerUi.url = sel;
    $('#input_baseUrl').val(sel);
    $('#explore').click();
});

window.swaggerUi.load();

};

Answer 1

我也在寻找一种解决此问题的方法，但是找不到。 这是我为解决问题而做的快速修改。 希望对遇到同样麻烦的人有所帮助。

在swagger-client.js中找到函数错误：function（response）{

我将return api_fail替换为addApiDeclaration，以使其即使失败也会用一些有限的信息绘制api。 我发送的虚拟api json对象的路径设置为“ /无法加载'+ _this.url。我发送的附加参数可以为true或false，其中true表示这是失败的api。

旧代码：

enter cerror: function (response) {
      _this.api.resourceCount += 1;
      return _this.api.fail('Unable to read api \'' +
      _this.name + '\' from path ' + _this.url + ' (server returned ' +response.statusText + ')');
    }

新密码

 error: function (response) {
      _this.api.resourceCount += 1;                                
      return _this.addApiDeclaration(JSON.parse('{"apis":[{"path":"/unable to load ' + _this.url + '","operations":[{"nickname":"A","method":" "}]}],"models":{}}'), true);
    }

我修改了同一个文件中的addApiDeclaration函数，以通过为失败的api显示不同的消息，方法是先向它添加一个名为failed的辅助参数，然后通过if语句检查是否失败，然后将api的名称更改为“ FAILED加载资源“ + this.name。 这会在失败的api之前添加FAILED TO LOAD RESOURCE文本。

旧代码

 SwaggerResource.prototype.addApiDeclaration = function (response) {
  if (typeof response.produces === 'string')
    this.produces = response.produces;
  if (typeof response.consumes === 'string')
    this.consumes = response.consumes;
  if ((typeof response.basePath === 'string') && response.basePath.replace(/\s/g, '').length > 0)
    this.basePath = response.basePath.indexOf('http') === -1 ? this.getAbsoluteBasePath(response.basePath) : response.basePath;
  this.resourcePath = response.resourcePath;
  this.addModels(response.models);
  if (response.apis) {
    for (var i = 0 ; i < response.apis.length; i++) {
      var endpoint = response.apis[i];
      this.addOperations(endpoint.path, endpoint.operations, response.consumes, response.produces);
    }
  }
  this.api[this.name] = this;
  this.ready = true;
  if(this.api.resourceCount === this.api.expectedResourceCount)
    this.api.finish();
  return this;
};

新密码

SwaggerResource.prototype.addApiDeclaration = function (response, failed) {
  if (typeof response.produces === 'string')
    this.produces = response.produces;
  if (typeof response.consumes === 'string')
    this.consumes = response.consumes;
  if ((typeof response.basePath === 'string') && response.basePath.replace(/\s/g, '').length > 0)
    this.basePath = response.basePath.indexOf('http') === -1 ? this.getAbsoluteBasePath(response.basePath) : response.basePath;
  this.resourcePath = response.resourcePath;
  this.addModels(response.models);
  if (response.apis) {
    for (var i = 0 ; i < response.apis.length; i++) {
      var endpoint = response.apis[i];
      this.addOperations(endpoint.path, endpoint.operations, response.consumes, response.produces);
    }
  }
  if (failed == true) {
      this.name = "FAILED TO LOAD RESOURCE - " + this.name;
  }
  this.api[this.name] = this;
  this.ready = true;
  if(this.api.resourceCount === this.api.expectedResourceCount)
    this.api.finish();
  return this;
};