通过以下链接搜索：
yyfjj / laravel-apidoc-generator
从您的 Laravel 应用程序生成美观的 API 文档
1.0
2019-07-24 05:15 UTC
Requires
- php: >=7.0.0
- fzaninotto/faker: ~1.8
- illuminate/console: 5.5.* || 5.6.* || 5.7.* || 5.8.*
- illuminate/routing: 5.5.* || 5.6.* || 5.7.* || 5.8.*
- illuminate/support: 5.5.* || 5.6.* || 5.7.* || 5.8.*
- league/flysystem: ^1.0
- mpociot/documentarian: ^0.2.0
- mpociot/reflection-docblock: ^1.0.1
- ramsey/uuid: ^3.8
Requires (Dev)
- dingo/api: 2.0.0-alpha1
- league/fractal: ^0.17.0
- mockery/mockery: ^1.2.0
- orchestra/testbench: 3.5.* || 3.6.* || 3.7.*
- phpunit/phpunit: ^6.0.0 || ^7.4.0
Suggests
- league/fractal: Required for transformers support
- nunomaduro/collision: For better reporting of errors that are thrpwn when generating docs
This package is auto-updated.
Last update: 2024-09-29 05:22:02 UTC
README
自动从您现有的 Laravel/Lumen/Dingo 路由生成 API 文档。 以下是输出示例。
php artisan apidoc:generate
安装
需要 PHP 7 和 Laravel 5.5 或更高版本。
composer require --dev mpociot/laravel-apidoc-generator
Laravel
通过运行以下命令发布配置文件：
php artisan vendor:publish --provider="Mpociot\ApiDoc\ApiDocGeneratorServiceProvider" --tag=apidoc-config
这将创建一个 apidoc.php 文件在您的 config 文件夹中。
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');
文档
请在 ReadTheDocs 查看文档。
许可证
Laravel API 文档生成器是免费软件，根据 MIT 许可证授权。