Описание

Данный проект предназначен для решения проблемы создания документации API. Проект основан на laravel 5 и swagger-php. Адрес источника проекта.

Журнал улучшений

• V1.1.1: исправлена проблема с версией зависимости пакета swagger-php (версии на swagger-php v2 используют стандарт PSR-4).
• 1 июля 2015 года [v1.1.0]: изменены маршруты.
• Изменена структура файлов проекта.
• Версия передней части swagger повышена до версии V2.1, используется передняя часть swagger адрес проекта.
• Проект был улучшен для автоматического загрузки по стандарту PSR-4, отказавшись от предыдущего стандарта PSR-0.

Установка

Рекомендуется использовать composer для установки:

1. В composer.json проекта настройте "riverslei/laravel-swagger": "~1.0".
2. Запустите composer update.
3. После завершения установки настройте config/app.php, указав поставщика услуг Riverslei\Swaggervel\SwaggervelServiceProvider::class.
4. После выполнения всех настроек запустите php artisan vendor:publish, чтобы создать соответствующие файлы конфигурации и ресурсы.

После выполнения этих настроек все работы по установке завершены, теперь можно приступить к запуску.

Запуск

Чтобы просмотреть маршрут api-doc, используйте следующую команду:

php artisan route:list

Если вы видите страницу swagger после доступа к baseUrl+api-docs, это означает, что установка прошла успешно.

Дополнение

После установки этой библиотеки вам больше не нужно запускать команды для генерации соответствующих файлов json. Всякий раз, когда вы посещаете страницу swagger вашего проекта, она автоматически сканирует связанные модели и контроллеры. Всё так просто! В будущем вам больше не придётся тратить время и силы на написание документации по интерфейсу API.

Здесь приведены правила написания аннотаций для swagger-php: официальный документ.