如何使用 aws API Gateway 从另一个模型引用一个模型

Question

假设我有一个模型：

"Pet":{
  "type": "object"
  "properties": {
    "name":{"type":"integer"},
    "age":{"type":"integer"}
  }
}

还有另一个模型：

"Human":{
  "type": "object"
  "properties": {
    "name":{"type":"integer"},
    "age":{"type":"integer"},
    "pets":{
      "type":"array"
      "items": {
        <This is where my question is>
      }
    }
  }
}

如何在我的人体模型中引用 Pet 模型？

我可以大摇大摆地说：

"$ref": "#/definitions/Pet"

但是 API Gateway 似乎不允许。

Answer 1

如果您指的是 swagger 之外的参考模型，则可以通过使用如下所示的绝对 url 指定模型来实现

 {"type":"array","items":{"$ref":"https://apigateway.amazonaws.com/restapis/<rest_api_id>/models/Pet"}}

对于 swagger，来自 open api 规范的这个示例展示了如何在 swagger 中引用模型 - https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v2.0/json/petstore.json

"Pets": {
  "type": "array",
  "items": {
    "$ref": "#/definitions/Pet"
  }

请注意，api 网关不支持“默认”响应，因此如果您尝试导入上述 petstore.json 示例，则需要删除“默认”字段。