属性和附加属性可以在 Swagger 2.0 中取空值吗？

Question

"DogRequest"{
  "type": "object",
  "properties": {
    "height": {
      "type": "string"
     }
  }
}


"DogResponse"{
  "type": "object",
  "properties": {
    "bark": {
      "type": "string"
     }
  }
}

请注意，我没有定义任何必需的属性。

我注意到在提出请求时，我可以设置 height=None

但是，在我的回复中，如果 bark=None，swagger 会引发验证错误，即 None 不是“字符串”类型。

让属性（和附加属性）为空的规则是什么，即使它们没有按要求定义？

我确实注意到，对于按要求定义的属性，它们必须存在且不为空。如果我想让属性为空，我必须包含“x-nullable”：true。

对于不需要的属性，我是否必须包含 "x-nullable": true ？

为什么我看到不一致？

Answer 1

OpenAPI 2.0 不支持 null 作为数据类型。一些工具使用x-nullable: true 来处理空值，但它不是 OpenAPI 规范的一部分，因此它是否有效取决于您使用的工具。

OpenAPI 3.0 中添加了对null 的支持，其中属性可以标记为nullable: true。