如何指定属性可以是null或带有swagger的引用

Question

我也想用昂首阔步做同样的事情。

为了总结以上问题的答案，使用jsonschema，可以这样做：

{
   "definitions": {
      "Foo": {
         # some complex object
      }
   },

   "type": "object",
   "properties": {
      "foo": {
         "oneOf": [
            {"$ref": "#/definitions/Foo"},
            {"type": "null"}
         ]
      }
   }
}

答案的关键点是使用之一。

注意：一些swagger实现使用x-nullable（或类似的）来指定属性值可以为null，但是，$ref用对象引用的内容替换对象，因此似乎忽略了对x-nullable的任何使用。

Answer 1

将该属性定义为$ref的anyof和类型:'null'。

YAML版本：

foo:
  anyOf:
    - type: 'null'   # Note the quotes around 'null'
    - $ref: '#/components/schemas/Foo'

JSON版本：

"foo": {
    "anyOf": [
        { "type": "null" },
        { "$ref": "#/components/schemas/Foo" }
    ]
}

foo:
  nullable: true
  allOf:
  - $ref: '#/components/schemas/Foo'

"foo": {
    "nullable": true,
    "allOf": [
        { "$ref": "#/components/schemas/Foo" }
    ]
}