昂首阔步的文档无法反映对象的价值

时间:2019-01-21 07:21:32

标签: swagger swagger-ui swagger-2.0 swagger-editor

我在swagger编辑器中定义了以下对象(amountInCurrency):

pot:
    type: object
    properties:
      potId:
        type: string
      name:
        type: string
      amount:
        type: number
      status:
        type: string
      lastChangeTimestamp:
        type: string
      amountInCurrency:
        type: object
        items:
          $ref: '#/definitions/amountInCurrency'

 amountInCurrency:
    type: object
    properties:
     currency:
      type: string
     amount:
      type: number

我得到了该项目的货币和金额。但是在醒目的可视化中,我将amountInCurrency视为一个空白地图。知道为什么吗?

我希望看到其中描述的货币和金额字段

enter image description here

-编辑: 如果我将AmountInCurrency类型从对象更改为数组,我会在文档中看到内部文档

这样做:

amountInCurrency:
            type: array
            items:
              $ref: '#/definitions/amountInCurrency'

enter image description here

1 个答案:

答案 0 :(得分:0)

amountInCurrency属性定义看起来不正确-将type: object与特定于数组的关键字items混合在一起。

如果amountInCurrency属性是amountInCurrency个对象的数组,请改用type: array

amountInCurrency:
  type: array   # <-----
  items:
    $ref: '#/definitions/amountInCurrency'

如果amountInCurrency属性是一个对象(amountInCurrency对象的实例),请像这样使用$ref

amountInCurrency:
  $ref: '#/definitions/amountInCurrency'