Установка и настройка Swagger

Всё что касается построения API
Закрыто
MrAmid
Сообщения: 7
Зарегистрирован: 2017.11.28, 17:55

Установка и настройка Swagger

Сообщение MrAmid »

Хотел бы открыть данную тему, так как на просторах интернета не так уж много информации о установке и настройке Swagger для Yii2. Хотелось бы получить развернутый ответ на данную тему. Обращаюсь к более опытным и знающим экспертам, пару строк об этом. Буду премного благодарен!
zelenin
Сообщения: 10596
Зарегистрирован: 2013.04.20, 11:30

Re: Установка и настройка Swagger

Сообщение zelenin »

что конкретно интересует? swagger (а ныне openapi) - это просто набор инструментов для описания апи. никакой специфики для yii2 нет. устанвливаем либу и поехали.
MrAmid
Сообщения: 7
Зарегистрирован: 2017.11.28, 17:55

Re: Установка и настройка Swagger

Сообщение MrAmid »

как именно это устанавливать. Мне нужно задокументировать существующую API с помощью Swagger. С чего начать? Можно подробнее описать процесс написания.
zelenin
Сообщения: 10596
Зарегистрирован: 2013.04.20, 11:30

Re: Установка и настройка Swagger

Сообщение zelenin »

установить через композер. каждый экшн пометить аннотациями с описанием, создать экшн, который будет отдавать собственно саму документацию - т.е. там будет ридер аннотаций в проекте.
Аватара пользователя
ElisDN
Сообщения: 5845
Зарегистрирован: 2012.10.07, 10:24
Контактная информация:

Re: Установка и настройка Swagger

Сообщение ElisDN »

MrAmid писал(а): 2017.11.29, 10:12 как именно это устанавливать.
Ставим библиотеку:

Код: Выделить всё

composer require --dev zircote/swagger-php
Прописываем аннотации к своим экшенам как в документации и примерах 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:

Код: Выделить всё

url: "swagger.json",
Всё. Открываем путь /docs/ в браузере.
MrAmid
Сообщения: 7
Зарегистрирован: 2017.11.28, 17:55

Re: Установка и настройка Swagger

Сообщение MrAmid »

Спасибо большое. Очень помогли!
Закрыто