Swagger в редакторе пасек отображает значение по умолчанию 0 как ноль - PullRequest
Новая
       24

Swagger в редакторе пасек отображает значение по умолчанию 0 как ноль

0 голосов
/ 07 сентября 2018

Я использую YAML-файл Swagger для создания интерактивной документации на apiary.io.

Я заметил странную проблему, когда, если я задаю значение по умолчанию 0 для целого числа, интерактивная документация вообще не отображает его и вместо этого показывает значение "ноль" в качестве значения по умолчанию. Если я укажу ненулевое значение, оно будет прекрасно отображаться.

Пример: 

- name: pageNumber
    in: query
    description: The page number, starting at 0.
    required: true
    type: number
    format: int32
    default: 0
- name: pageSize
    in: query
    description: The page size (max number of entities that are displayed in the
      response).
    required: true
    type: integer
    format: int32
    default: 20

Добавляет ?pageNumber=&pageSize=20 к моему пути, тогда как он должен был добавить ?pageNumber=0&pageSize=20.

Когда я добавляю ненулевое значение следующим образом: 

    - name: pageNumber
    in: query
    description: The page number, starting at 0.
    required: true
    type: number
    format: int32
    default: 1
- name: pageSize
    in: query
    description: The page size (max number of entities that are displayed in the
      response).
    required: true
    type: integer
    format: int32
    default: 20

Это отображается нормально и добавляет ?pageNumber=1&pageSize=20, как и ожидалось.

1 Ответ

0 голосов
/ 07 сентября 2018

Комментарий Елены решил мою проблему. При документировании с использованием YAML на apiary.io для установки начальных / стандартных значений в интерактивной документации необходимо использовать x-example. Теперь, как и ожидалось, работает следующее: 

  - name: pageNumber
    in: query
    description: The page number, starting at 0.
    required: true
    type: number
    format: int32
    x-example: 0
  - name: pageSize
    in: query
    description: The page size (max number of entities that are displayed in the
      response).
    required: true
    type: integer
    format: int32
    x-example: 20

Успешно отображается как ?pageNumber=0&pageSize=20

...