通过
进行搜索
进行搜索hydreflab/ laravel-apidoc-generator
从您的Laravel应用程序生成美观的API文档
3.1.0
2018-11-28 20:25 UTC
Requires
- php: >=7.0.0
- fzaninotto/faker: ~1.8
- illuminate/console: 5.5.* || 5.6.* || 5.7.*
- illuminate/routing: 5.5.* || 5.6.* || 5.7.*
- illuminate/support: 5.5.* || 5.6.* || 5.7.*
- 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
- dev-master
- 3.1.0
- 3.0.6
- 3.0.5
- 3.0.4
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
- 2.x-dev
- 2.1.8
- 2.1.7
- 2.1.6
- 2.1.5
- 2.1.4
- 2.1.3
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.0
- 1.7.0
- 1.6.7
- 1.6.6
- 1.6.5
- 1.6.4
- 1.6.3
- 1.6.2
- 1.6.1
- 1.6.0
- 1.5.2
- 1.5.1
- 1.5.0
- 1.4.4
- 1.4.3
- 1.4.2
- 1.4.1
- 1.4.0
- 1.3.0
- 1.2.6
- 1.2.5
- 1.2.4
- 1.2.3
- 1.2.2
- 1.2.1
- 1.2.0
- 1.1.1
- 1.1.0
- 1.0.1
- 1.0.0
- 0.2.0
- 0.1.0
- dev-feature/support-multiple-response-tags
This package is auto-updated.
Last update: 2024-09-24 16:23:18 UTC
README
从现有的Laravel/Lumen/ Dingo 路由自动生成您的API文档。
php artisan apidoc:generate
安装
需要PHP 7.2和Laravel/Lumen 5.7或更高版本。
如果您的应用程序不满足这些要求，您可以查看3.x分支以获取旧版本。
composer require --dev mpociot/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许可证授权。