swagger-ui 不显示 400 的响应模型

Question

这是我生成的 swagger 文档的摘录。

    "responses": {
      "200": {
        "description": "successful operation",
        "schema": {
          "$ref": "#/definitions/ActionJsValue"
        }
      },
      "400": {
        "description": "list of validation errors",
        "schema": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Error"
          }
        }
      }
    }

在定义部分：

"Error": {
  "type": "object",
  "properties": {
    "path": {
      "type": "string"
    },
    "messages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
},

而且 swagger-ui 不显示响应模型。

有人遇到过这个问题吗？ 有谁知道如何解决这个问题？

Answer 1

我遇到了完全相同的问题并找到了下一个解决方法。

方法说明：

"responses": {
  "200": {
    "description": "successful operation",
    "schema": {
      "$ref": "#/definitions/ActionJsValue"
    }
  },
  "400": {
    "description": "list of validation errors",
    "schema": {
      "$ref": "#/definitions/ErrorsArray"
    }
  }
}

定义部分：

"ErrorsArray": {
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "path": {
        "type": "string"
      },
      "messages": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  }
}

所以，只需将您的数组定义为单独的类型。

Answer 2

无论您用于生成 swagger doc 的 url，您需要在 swagger-ui index.html 页面中使用的相同 url。 EX：如果您使用 "http://{servername}:{port}/{App-Context}/{url-pattern}/swagger.json" 生成 swagger doc，那么在 index.html 中也必须使用下面。

<script type="text/javascript">
$(function () {
  var url = window.location.search.match(/url=([^&]+)/);
  if (url && url.length > 1) {
    url = decodeURIComponent(url[1]);
  } else {
    url = "http://petstore.swagger.io/v2/swagger.json";// you need to change this url to your's url http://{servername}:{port}/{App-Context}/{url-pattern}/swagger.json
  }

如果对您有帮助，请告诉我，谢谢。