FitTech
@FitTech

Создание документации Swagger в помощью Symfony?

Здравствуйте! В данной теме не силен и из-за этого прошу подсказки у кого есть опыт. В наличии Symfony 3 и есть api. Существует ли swagger бандл для данной симфони который пройдется по всем контроллерам и сделает документацию api?
Аннотации к методам описаны.
  • Вопрос задан
  • 2019 просмотров
Пригласить эксперта
Ответы на вопрос 2
Decadal
@Decadal
сделает документацию вместо вас? О, я тоже когда-то думал, что такой инструмент есть.
Но, знаете ли, сваггер не может понять, какие именно вы параметры обрабатываете, какие ожидаете, и какая у них валидация. Поэтому вы можете подключить сваггер, а потом написать аннотации, по которым будет построена схема. Всё придётся писать руками.
Может быть, для каких-то более строгих языков типа Java это возможно. Но для нашего php все руками.
Ответ написан
@galliard
Какие именно аннотации к методам у вас описаны?
Если стандартные аннотации компонентов symfony (включая jms и doctrine, хотя формально они не являются компонентами симфони) - то такое умеет только NelmioApiDocBundle, и то в весьма ограниченом виде.

Есть еще вот такая приблуда: https://packagist.org/packages/zircote/swagger-php (она же входит в состав NelmioApiDocBundle, кстати), у нее есть собственные кастомные аннотации, из которых она генерит описание в json-формате.

Иных инструментов пока нет.
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы