khazhinov / laravel-fly-docs
Library for generating documentation for the OpenApi 3.0 standard in the Laravel ecosystem with a built-in UI
Installs: 3 516
Dependents: 1
Suggesters: 0
Security: 0
Stars: 1
Watchers: 1
Forks: 2
Open Issues: 2
Requires
- php: ^8.1
- ext-exif: *
- ext-fileinfo: *
- ext-json: *
- ext-sodium: *
- doctrine/dbal: ^2.6|^3.0
- goldspecdigital/oooas: ^2.7.1
- illuminate/bus: ^10.0
- illuminate/config: ^10.0
- illuminate/console: ^10.0
- illuminate/database: ^10.0
- illuminate/http: ^10.0
- illuminate/pipeline: ^10.0
- illuminate/support: ^10.0
- khazhinov/php-support: ^1.0
- phpdocumentor/reflection-docblock: ^5.0
- spatie/data-transfer-object: ^3.8
- swagger-api/swagger-ui: ^3.0 || ^4.0
- symfony/console: ^6.1
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.11
- laravel/framework: ^10.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-symfony: ^1.2
README
Laravel FlyDocs 📚
Библиотека для формирования документации по стандарту OpenApi 3.0 в экосистеме Laravel со встроенным UI
Описание
Данная библиотека является форком vyuldashev/laravel-openapi. Документация по основным сущностям доступна по ссылке.
Обратите внимание, что Artisan команды FlyDocs начинаются с fly-docs:, например:
Команда в исходной библиотеке:
$ php artisan openapi:make-requestbody StoreUser
Команда FlyDocs:
$ php artisan fly-docs:make-requestbody StoreUser
Установка
Для установки использовать:
$ composer require khazhinov/laravel-fly-docs
Благодарности ❤️
Большая благодарность Владимиру Юлдашеву, чья библиотека vyuldashev/laravel-openapi стала фундаментом данного решения.
Лицензия
Лицензия MIT. Для получения большей информации обращайтесь к тексту лицензии.