主页 / coding / 问题 / 78791657
Accepted
JDev
Asked: 2024-07-25 13:56:48 +0800 CST

Swagger UI 和 OpenAPI 3 - 通过示例 $ref 切换请求主体示例

  • 772

我有 2 个架构和一个示例。我想使用下拉菜单更改请求主体。

实际上一切都正常。我有一个显示示例的列表，并且仅当我将示例写为“value”时，RequestBody 中的值才会更改。如果我将示例指定为 ref，则会加载第一个示例，但当下拉列表中的值发生变化时不会显示第二个示例。

这难道只是没有实现，这是一个错误还是我做错了什么/配置了什么？

截屏： 在此处输入图片描述

配置示例：

"requestBody": {
  "content": {
    "application/json": {
      "schema": {
        "oneOf": [
          {"$ref": "#/components/schemas/reportexample1"},
          {"$ref": "#/components/schemas/reportexample2"}
        ]
      },
      "examples": {
        "reportexample1": {
          "summary": "reportexample1",
          "$ref": "#/components/schemas/reportexample1"
        },
        "reportexample2": {
          "summary": "reportexample2",
          "$ref": "#/components/schemas/reportexample2"
        }
      }
    }
  }
},

......

  "components": {
    "schemas": {
      "reportexample1": {
        "type": "object",
        "properties": { .... }
      },
      "reportexample2": {
        "type": "object",
        "properties": { .... }
      }
    }
  }
openapi

2 个回答

  1. Best Answer

    $ref要在中使用，必须在部分中定义examples参考示例并使用示例对象语法。components/examples

    examples无法引用模式（#/components/schemas/...） – 这就是您的原始代码片段不起作用的原因。

    尝试这个：

          "examples": {
        "reportexample1": {
          "$ref": "#/components/examples/reportexample1"
        },
        "reportexample2": {
          "$ref": "#/components/examples/reportexample2"
        }
      }
      ...

  "components": {
    "examples": {
      "reportexample1": {
        "summary": "Example of reportexample1",
        "value": {
          "prop1": "value1",
          "prop2": 123
        }
      },
      "reportexample2": {
        "summary": "Example of reportexample2",
        "value": {
          "prop3": true,
          "prop4": [5, 6, 7]
        }
      }
    }
  }

    Artur May 的答案中建议的内联示例方法也将起作用。

    • 2

  2. 您可以尝试直接在示例部分中定义示例，而不是使用 $ref 引用它们。

    像这样：

    "requestBody": {
  "content": {
    "application/json": {
      "schema": {
        "oneOf": [
          {"$ref": "#/components/schemas/reportexample1"},
          {"$ref": "#/components/schemas/reportexample2"}
        ]
      },
      "examples": {
        "reportexample1": {
          "summary": "reportexample1",
          "value": {
            // Provide the actual example value for reportexample1 here
            "property1": "value1",
            "property2": "value2"
          }
        }
      }
    }
  }
}
    • 0

相关问题