Swagger Docs не отражает стоимость объекта - PullRequest
0 голосов
/ 21 января 2019

Я определил в редакторе сваггеров следующий объект (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

Я получил в этих товарах валюту и сумму.Однако на визуализации чванства я вижу сумму InCurrency как пустую карту.есть идеи почему?

я ожидал бы увидеть описанные в ней поля валюты и суммы

enter image description here

- изменить: если я изменю тип AmountInCurrencyот объекта к массиву я вижу внутренние документы в документе

, которые делают это:

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

enter image description here

1 Ответ

0 голосов
/ 21 января 2019

Определение свойства amountInCurrency выглядит неправильно - оно смешивает type: object с ключевым словом для массива items.

Если свойство amountInCurrency является массивом amountInCurrency объектов,используйте type: array вместо:

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

Если свойство amountInCurrency является объектом (экземпляром объекта amountInCurrency), используйте $ref, например, так:

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