Установка и настройка Swagger
Установка и настройка Swagger
Хотел бы открыть данную тему, так как на просторах интернета не так уж много информации о установке и настройке Swagger для Yii2. Хотелось бы получить развернутый ответ на данную тему. Обращаюсь к более опытным и знающим экспертам, пару строк об этом. Буду премного благодарен!
Re: Установка и настройка Swagger
что конкретно интересует? swagger (а ныне openapi) - это просто набор инструментов для описания апи. никакой специфики для yii2 нет. устанвливаем либу и поехали.
Re: Установка и настройка Swagger
как именно это устанавливать. Мне нужно задокументировать существующую API с помощью Swagger. С чего начать? Можно подробнее описать процесс написания.
Re: Установка и настройка Swagger
установить через композер. каждый экшн пометить аннотациями с описанием, создать экшн, который будет отдавать собственно саму документацию - т.е. там будет ридер аннотаций в проекте.
Re: Установка и настройка Swagger
Ставим библиотеку:
Код: Выделить всё
composer require --dev zircote/swagger-php
Запускаем генерацию json-файла:
Код: Выделить всё
vendor/bin/swagger controllers web/docs/swagger.json
В файле index.html меняем url:
Код: Выделить всё
url: "swagger.json",
Re: Установка и настройка Swagger
Спасибо большое. Очень помогли!