通过
搜索
搜索雪软 / laravel-apidoc-generator
从您的Laravel应用程序生成美观的API文档
v0.0.8
2023-03-15 11:45 UTC
Requires
- php: >=8.0.0
- ext-json: *
- fakerphp/faker: ^v1.9.1
- illuminate/console: ^5.7|^6.0|^7.0|^8.0|^9.0|^10.0
- illuminate/routing: ^5.7|^6.0|^7.0|^8.0|^9.0|^10.0
- illuminate/support: ^5.7|^6.0|^7.0|^8.0|^9.0|^10.0
- league/flysystem: ^3.12.3
- mpociot/reflection-docblock: ^1.0.1
- nunomaduro/collision: ^3.0|^4.0|^5.0|^6.0|^7.0
- ramsey/uuid: ^3.8|^4.0
- snowsoft/documentarian: ^0.0.2
- symfony/var-exporter: ^4.0|^5.0|^6.0
Requires (Dev)
- dms/phpunit-arraysubset-asserts: ^0.1.0
- laravel/lumen-framework: ^5.7|^6.0|^7.0|^8.0|^9.0
- league/fractal: ^0.19.0
- orchestra/testbench: ^3.7|^4.0|^5.0
- phpstan/phpstan: ^0.11.15
- phpunit/phpunit: ^8.0
Suggests
- league/fractal: Required for transformers support
README
自动从您的现有Laravel/Lumen/Dingo路由生成API文档。
php artisan apidoc:generate
安装
需要PHP 7.2和Laravel/Lumen 5.7或更高版本。
如果您的应用程序不符合这些要求，您可以查看3.x分支以获取旧版本。
composer require --dev snowsoft/laravel-apidoc-generator
Laravel
通过运行以下命令发布配置文件
php artisan vendor:publish --provider="Mpociot\ApiDoc\ApiDocGeneratorServiceProvider" --tag=apidoc-config
这将创建一个位于您的config文件夹中的apidoc.php文件。
Lumen
- 当使用Lumen时，您需要运行
composer require mpociot/laravel-apidoc-generator。 - 在您的
bootstrap/app.php中注册服务提供者
$app->register(\Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class);
- 将配置文件从
vendor/mpociot/laravel-apidoc-generator/config/apidoc.php复制到您的项目中作为config/apidoc.php。然后将其添加到您的bootstrap/app.php中。
$app->configure('apidoc');
文档
请查阅Beyond Code主页上的文档。
许可证
Laravel API文档生成器是免费软件，许可协议为MIT。