Пользовательский интерфейс Swagger не отображает значения перечисления в моделях

У меня возникла небольшая проблема с использованием пользовательского интерфейса Swagger, и я еще не уверен, является ли это ошибкой или нет...

Я описал свой API с помощью редактора Swagger, и у меня есть метод, содержащий параметр enum.

Теперь проблема: в сгенерированной документации Swagger-UI на вкладке «модель» у меня есть пустое определение объекта «messageType» :( Я хочу отобразить разрешенные значения (БРЕНД, ПОСЕТИТЕЛЬ, КОММЕНТАРИЙ и ОТВЕТ)

Фрагмент кода для воспроизведения:

swagger: '2.0'
info:
  version: 1.0.0-SNAPSHOT
  title: foo
  description: foo
host: dev.fr
basePath: /base
schemes:
  - http
  - https
consumes:
  - application/json
produces:
  - application/json

paths:
  /social/message:
    post:
      operationId: create
      responses:
        '201':
          schema:
            $ref: '#/definitions/message'
        'default':
          description: Default error response

definitions:
  message:
    required:
      - title
      - messageType
    properties:
      title:
        type: string
      messageType:
        $ref: '#/definitions/messageType'

  messageType:
    enum:
      - COMMENT
      - RESPONSE

захват экрана

Есть идеи ? Я делаю это неправильно? Это ошибка? Большое спасибо :)


person hiveship    schedule 31.05.2016    source источник
comment
Ваш messageType не заявляет, что он type. enum не является допустимым типом в схеме JSON. Рассмотрите возможность добавления type: string в качестве брата в перечисление.   -  person fehguy    schedule 31.05.2016
comment
Ты прав! Спасибо :)   -  person hiveship    schedule 01.06.2016


Ответы (1)


fehguy прав, проблема решена добавлением «type: string» к моему объекту :)

person hiveship    schedule 01.06.2016