Swagger不同对象的数组

时间:2017-06-28 10:04:05

标签: swagger swagger-2.0 json-api

例如,我需要以swagger yaml格式表示以下结构:

  "included": [
    {
      "type": "people",
      "id": "42",
      "attributes": {
        "name": "John",
        "age": 80,
        "gender": "male"
      }
    }
  ]

使用单个对象一切都很好:

  included:
    type: "array"
    items:
      type: object
      properties:
        type:
          type: "string"
        # and so on 

问题是如果我需要描述如下内容:

"included": [{
    "type": "people",
    "id": "9",
    "attributes": {
      "first-name": "Dan",
      "last-name": "Gebhardt",
      "twitter": "dgeb"
    },
    "links": {
      "self": "http://example.com/people/9"
    }
  }, {
    "type": "comments",
    "id": "5",
    "attributes": {
      "body": "First!"
    },
    "relationships": {
      "author": {
        "data": { "type": "people", "id": "2" }
      }
    },
    "links": {
      "self": "http://example.com/comments/5"
    }
  }, {
    "type": "comments",
    "id": "12",
    "attributes": {
      "body": "I like XML better"
    },
    "relationships": {
      "author": {
        "data": { "type": "people", "id": "9" }
      }
    },
    "links": {
      "self": "http://example.com/comments/12"
    }
  }]

我知道在OpenAPI中它可能(也就是招摇3)并在当前版本中尝试了一些解决方法,但没有运气。

0 个答案:

没有答案