Ссылка: https://github.com/vaneves/apirus
Создайте новый проект Laravel,в него добавьте Apirus средства в проект, введите команду установки:
композитор создать-проект –предпочитаю-удаленные ванвес/эпир
Se для установки на форумах, посвященных проекту Laravel,используйте команду:
композитор создает-проект –предпочитает-удаленные ванты/epirus meu_projeto
Блюдо из пасты эпир . Измените имя файла .окр.exemple для .env
cp .env.пример .env
В файле .окр измените переменные среды.
API_URL=http://example.com/api SOURCE= DIST= THEME= HIGHTLIGHT=
Войдите в папке apirus ,а затем “ДОКУМЕНТЫ”, будет в этом каталоге, что мы должны представить документацию для нашего API,в формате markdown,так что интерпретатор, предоставьте нам визуальный интерфейс и простой для обработки и тестирования.
В каталоге/docs обновите документации, отправив свой новый каталог с файлами.
Внутри папки DOCS ,должны иметь что-то вроде этого. Файлы Уценка .md что будет форматировать код так, чтобы графический интерфейс инструмента,может предоставить нам документацию и тестирование более удобным для пользователей.
После этого процесса,нам нужно buildar обновления,digitaremos следующие команды:
Войдите в папку apirus
–локальный хост/эпир
Введите команду начальный
Она:
php эпир
Введите команду комплектации
И обновление документации, введите эту команду после обновления подкаталог в каталоге/docs. Команда:
php apirus –документы src -h монокай
Готово,все в порядке,мы можем иметь в результате в документации api::
http://localhost/meu_projeto/public/
В разработке/доработке Видео-Учебник: В разработке/доработке
Оригинал: “https://dev.to/guillerbr/documentar-uma-api-em-laravel-com-o-apirus-ferramenta-visual-2n85”