如何使用JSON Schema和Swagger在API网关模型中声明多种类型的属性？

Question

根据AWS文档，API Gateway中的模型支持JSON Schema语法，但是，它们导出为Swagger OpenAPI规范，其中Swagger规范不完全支持许多有效的JSON Schema结构。

我希望我的API Gateway模型有一组可选的文本字段，例如message，但当定义为

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }

}

并且启用了主体验证，当消息为空字符串或丢失时，它会拒绝此模型。即使＜code＞消息

  "required": [
      "message"
    ],

四处挖掘，我发现要允许空/空字符串值，必须将空类型添加到属性类型列表中，例如：

{
    "type": ["null", "string"]
}

然而，这仍然不能与API Gateway一起工作，也不能正确地作为Swagger spec YAML导出。

有没有办法通过API网关和Swagger解决这个问题？

Answer 1

正如海伦所提到的，Swagger 不支持多种类型，也不支持 null 作为一种类型。这可能会阻止您的第一种方法使用 swagger 导入/导出。

但是，内部API网关模型支持确实使用JSON模式，即使导入/导出不使用，也可以工作。我建议您尝试通过API网关控制台或API网关CLI输入模型。