通过
搜索
搜索hahadu / laravel-apidoc-generator
从您的Laravel应用程序生成漂亮的API文档
v0.3.1
2023-03-20 07:10 UTC
Requires
- php: >=7.2.0
- ext-json: *
- fakerphp/faker: ^1.9
- hahadu/documentarian: ^0.2
- hahadu/postman-api: ^0.1
- hahadu/reflector: ^1.0
- league/flysystem: ^1.0
- nunomaduro/collision: ^5.0
- ramsey/uuid: ^3.8|^4.0
- symfony/var-exporter: ^4.0|^5.0
Requires (Dev)
- dms/phpunit-arraysubset-asserts: ^0.3
- 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 7.2和Laravel/Lumen 8.1或更高版本。
如果您的应用程序不满足这些要求，您可以查看3.x分支以获取旧版本。
composer require hahadu/laravel-apidoc-generator
和
composer dump or composer update
Laravel
通过运行以下命令发布配置文件：
php artisan vendor:publish --provider="Hahadu\ApiDoc\ApiDocGeneratorServiceProvider" --tag=apidoc-config
这将创建一个位于您的config文件夹中的apidoc.php文件。
Lumen
- 当使用Lumen时，您需要运行
composer require mpociot/laravel-apidoc-generator。 - 在您的
bootstrap/app.php中注册服务提供者
$app->register(\Hahadu\ApiDoc\ApiDocGeneratorServiceProvider::class);
- 将配置文件从
vendor/mpociot/laravel-apidoc-generator/config/apidoc.php复制到您的项目中的config/apidoc.php。然后添加到您的bootstrap/app.php。
$app->configure('apidoc');
文档
php artisan apidoc:generate
请查看Beyond Code主页上的文档。
许可证
Laravel API文档生成器是免费软件，根据MIT许可证授权。