swagger - 任何 : {$ref} in swagger JSON schema definition

Question

我尝试使用 swagger 来描述 JSON API。到目前为止它看起来不错，但我无法弄清楚如何使用 anyOf 结构在 JSON 答案中定义不同对象类型的数组。

以下 JSON Schema 是有效的，它应该描述 Article 和 Video JSOn 对象的数组:

{
"Article":{
  "id":"Article",
  "required": ["title"],
  "properties":{
    "title":{
      "type":"string",
      "description": "Title of the article"
    }
  }
},

"Video":{
  "id":"Video",
  "required": ["title"],
  "properties":{
    "title":{
      "type":"string",
      "description": "Title of the video"
    }
  }
},

"News":{
  "id":"News",
  "required": ["instance_data"],
  "properties":{
    "instance_data":{
        "anyOf":[
           { "$ref": "Article" },
           { "$ref": "Video" } ],
      "description": "News instance data"
    }
  }
}
}

但是在 swagger 中，对象类型总是显示为 undefined 而不是“文章或视频”。

是否有可能 Swagger 完成这项工作？

Answer 1

需要说明的是:Swagger v2.0 不支持 anyOf。在这里阅读更多:https://github.com/swagger-api/swagger-spec/issues/57