swagger - 如何在 OpenAPI (Swagger) 中定义枚举？

Question

有谁知道如何在 OpenAPI 2.0 定义中定义可能的 enum 值，以便它们显示在 Swagger UI 的“模型”选项卡中？
Example here status 属性有一个枚举选项。
如何在 OpenAPI 2.0 中定义这样的枚举？

Answer 1

"enum"在 OpenAPI 2.0 中的工作方式如下:

      {
        "in": "query",
        "name": "sample",
        "description": "a sample parameter with an enum value",
        "type": "string",
        "enum": [ "1", "2"],
        "required": true
      }

在 OpenAPI 3.0 中:

      {
        "in": "query",
        "name": "sample",
        "description": "a sample parameter with an enum value",
        "schema": {
          "type": "string",
          "enum": [ "1", "2"]
        },
        "required": true
      }

如您所见，有一个名为 sample 的查询参数，类型为字符串，并且有一个说明两个可能值的枚举。在这种情况下，示例说明该参数是必需的，因此 UI 不会显示空值作为选项。

对于一个最小的工作示例，试试这个:

{
  "swagger": "2.0",
  "info": {
    "title": "title",
    "description": "descriptor",
    "version": "0.1"
  },
  "paths": {
    "/sample": {
      "post": {
        "description": "sample",
        "parameters": [
          {
            "in": "query",
            "name": "sample",
            "description": "a sample parameter with an enum value",
            "type": "string",
            "enum": [
              "1",
              "2"
            ],
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "Successful request."
          }
        }
      }
    }
  }
}

要在本地测试它，您可以在 javascript 中声明一个变量(例如 spec)，并将其传递给 SwaggerUi 对象。

  var spec = { ... };

  window.swaggerUi = new SwaggerUi({
    url: url,
    spec: spec,
    dom_id: "swagger-ui-container",
    supportedSubmitMethods: ['get', 'post', 'put', 'delete'],
    onComplete: function(swaggerApi, swaggerUi){
    ...

在这种情况下，url 参数将被忽略。

最终，输出如下所示: