Страница 1 из 1
Установка и настройка Swagger
Добавлено: 2017.11.28, 18:05
MrAmid
Хотел бы открыть данную тему, так как на просторах интернета не так уж много информации о установке и настройке Swagger для Yii2. Хотелось бы получить развернутый ответ на данную тему. Обращаюсь к более опытным и знающим экспертам, пару строк об этом. Буду премного благодарен!
Re: Установка и настройка Swagger
Добавлено: 2017.11.28, 21:52
zelenin
что конкретно интересует? swagger (а ныне openapi) - это просто набор инструментов для описания апи. никакой специфики для yii2 нет. устанвливаем либу и поехали.
Re: Установка и настройка Swagger
Добавлено: 2017.11.29, 10:12
MrAmid
как именно это устанавливать. Мне нужно задокументировать существующую API с помощью Swagger. С чего начать? Можно подробнее описать процесс написания.
Re: Установка и настройка Swagger
Добавлено: 2017.11.29, 11:03
zelenin
установить через композер. каждый экшн пометить аннотациями с описанием, создать экшн, который будет отдавать собственно саму документацию - т.е. там будет ридер аннотаций в проекте.
Re: Установка и настройка Swagger
Добавлено: 2017.11.29, 20:00
ElisDN
MrAmid писал(а): ↑2017.11.29, 10:12
как именно это устанавливать.
Ставим библиотеку:
Прописываем аннотации к своим экшенам как в документации и примерах
https://github.com/zircote/swagger-php из папок docs и examples.
Запускаем генерацию json-файла:
Код: Выделить всё
vendor/bin/swagger controllers web/docs/swagger.json
В папку web/docs распаковываем содержимое папки dist пакета
https://github.com/swagger-api/swagger-ui
В файле index.html меняем url:
Всё. Открываем путь /docs/ в браузере.
Re: Установка и настройка Swagger
Добавлено: 2017.12.08, 16:52
MrAmid
Спасибо большое. Очень помогли!