在Open API 3.0中的响应主体中描述对象中管道分隔的编码

时间:2020-08-03 02:38:19

标签: swagger openapi swagger-3.0

因此,也许我正在尝试在描述符中进行过多的说明,但这是我的用例。在为API定义响应主体中返回的对象的架构时,我拥有该对象的一个​​属性,该对象的值是具有可变属性的对象,因此我使用的是additionalProperties描述符。

{
  "type": "object",
  "additionalProperties": {
    "type": "string"
  }
}

但是,我不想将这个变量键对象中的type的值描述为string,而是希望更精确地描述它们,因为该字符串实际上是数组的管道分隔序列化。示例:

{
  "property1": {
    "variableProperty1": "info1|info2|info3",
    "variableProperty2": "info1|info2|info3"
  }
}

有什么办法描述这种管道分隔的序列化?像这样:

{
  "type": "object",
  "additionalProperties": {
    "type": "array",
    "explode": false,
    "encoding": {
      "style": "pipeDelimited"
    }
  },
}

或者这仅适用于query parameters吗?

0 个答案:

没有答案
相关问题