array of objectsを表現するswagger記法

OpenAPI v3におけるYAMLの記法です。

yaml

results:
  type: array
  items:
    type: object
    properties:
      AA:
        type: string
      BB:
        type: string
      CC:
        type: string
      DD:
        type: string
      EE:
        type: string
  example:
    - AA: aa
      BB: bb
      CC: cc
      DD: dd
      EE: ee
    - AA: aa
      DD: dd
      EE: ee
    - AA: aa
      BB: bb
      CC: cc

出力

{
  "results": [
    {
      "AA": "aa",
      "BB": "bb",
      "CC": "cc",
      "DD": "dd",
      "EE": "ee"
    },
    {
      "AA": "aa",
      "DD": "dd",
      "EE": "ee"
    },
    {
      "AA": "aa",
      "BB": "bb",
      "CC": "cc"
    }
  ]
}

exampleで指定されていない値はkeyごとskipされるようになります