Сообщение Swagger CSV

Мы работаем над документацией Swagger для нашей реализации Laravel REST API. Некоторые конечные точки POST будут использовать CSV в качестве типа содержимого параметра.

Есть ли в Swagger способ заставить функцию "Попробовать сейчас" работать с загрузкой CSV-файла POST?

Ниже представлена ​​наша документация в процессе http://api.curvecompass.com/docs/#/

У нас есть функция Laravel POST, правильно работающая с конечной точкой CSV, но не с документами Swagger.


csv laravel swagger swagger-ui swagger-php
person mwex501    schedule 09.02.2018    source источник
comment
stackoverflow.com/questions/14455408/ указать вам правильное направление?   -  person ceejayoz    schedule 13.02.2018
comment
Вы используете Swagger 2.0 или Swagger 3.0?   -  person Tarun Lalwani    schedule 13.02.2018
comment
@TarunLalwani 3.0   -  person mwex501    schedule 14.02.2018
comment
Просто чтобы уточнить - вы имеете в виду, что 1) операция потребляет Content-Type: text/csv, а тело ответа представляет собой текст в формате CSV; 2) операция представляет собой запрос на загрузку файла (multipart/form-data), который ожидает файл CSV как часть составной полезной нагрузки?   -  person Helen    schedule 14.02.2018
comment
@Helen В настоящее время мы используем Laravel — мы создали конечную точку, которая принимает файл HTML POST, содержащий данные CSV. Мы хотим добавить в нашу документацию Swagger функцию «Попробовать сейчас», которая будет принимать CSV-файл в данные формы и передавать его в конечную точку Laravel для приема.   -  person mwex501    schedule 15.02.2018

Ответы (2)


arrow_upward
0
arrow_downward

swagger ui для открытого API 3.0 пока не поддерживает загрузку файлов. вы можете посмотреть обновление здесь https://github.com/swagger-api/swagger-ui/issues/3641

person bhill77    schedule 14.02.2018
comment
Разит. На данный момент я был бы готов принять взлом, если у кого-то есть что предложить. В противном случае я просто взломаю его сам. Спасибо за информацию. - person mwex501; 17.02.2018

arrow_upward
0
arrow_downward

Вы можете попробовать это.

consumes:
    - multipart/form-data  # and/or application/x-www-form-urlencoded
  parameters:
    - name: file
      in: formData
      description: The uploaded file data
      required: true
      type: file
person Pratik Mehta    schedule 21.02.2018